Class SymbolPaletteBuilder
Inheritance
System.Object
SymbolPaletteBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class SymbolPaletteBuilder : ControlBuilder
Constructors
SymbolPaletteBuilder()
Declaration
public SymbolPaletteBuilder()
SymbolPaletteBuilder(SymbolPalette)
Declaration
public SymbolPaletteBuilder(SymbolPalette model)
Parameters
Fields
model
Declaration
public SymbolPalette model
Field Value
Properties
HtmlAttr
Declaration
public IDictionary<string, object> HtmlAttr { get; set; }
Property Value
Type |
Description |
System.Collections.Generic.IDictionary<System.String, System.Object> |
|
ID
Declaration
public string ID { get; set; }
Property Value
Type |
Description |
System.String |
|
Output
Declaration
public override TextWriter Output { get; set; }
Property Value
Type |
Description |
System.IO.TextWriter |
|
Overrides
Methods
AccessKey(String)
Configures the key, when it pressed the symbol palette will be focused
Declaration
public SymbolPaletteBuilder AccessKey(string accessKey)
Parameters
Type |
Name |
Description |
System.String |
accessKey |
|
Returns
AllowDrag(Boolean)
Defines whether the symbols can be dragged from palette or not
Declaration
public SymbolPaletteBuilder AllowDrag(bool allowDrag = true)
Parameters
Type |
Name |
Description |
System.Boolean |
allowDrag |
|
Returns
ConnectorDefaults(Object)
Helps to return the default properties of connectors
Declaration
public SymbolPaletteBuilder ConnectorDefaults(object connectorDefaults)
Parameters
Type |
Name |
Description |
System.Object |
connectorDefaults |
|
Returns
EnableAnimation(Boolean)
Enables/Disables animation when the palette header is expanded/collapsed
Declaration
public SymbolPaletteBuilder EnableAnimation(bool enableAnimation = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enableAnimation |
|
Returns
EnablePersistence(Boolean)
Enable or disable persisting component's state between page reloads.
Declaration
public SymbolPaletteBuilder EnablePersistence(bool enablePersistence = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enablePersistence |
|
Returns
EnableRtl(Boolean)
Enable or disable rendering component in right to left direction.
Declaration
public SymbolPaletteBuilder EnableRtl(bool enableRtl = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enableRtl |
|
Returns
EnableSearch(Boolean)
Enables/Disables search option in symbol palette
Declaration
public SymbolPaletteBuilder EnableSearch(bool enableSearch = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enableSearch |
|
Returns
ExpandMode(Object)
Defines how many palettes can be at expanded mode at a time
Declaration
public SymbolPaletteBuilder ExpandMode(object expandMode)
Parameters
Type |
Name |
Description |
System.Object |
expandMode |
|
Returns
FilterSymbols(Object)
Defines the symbols to be added in search palette
Declaration
public SymbolPaletteBuilder FilterSymbols(object filterSymbols)
Parameters
Type |
Name |
Description |
System.Object |
filterSymbols |
|
Returns
FilterSymbols(String)
Defines the symbols to be added in search palette
Declaration
public SymbolPaletteBuilder FilterSymbols(string filterSymbols)
Parameters
Type |
Name |
Description |
System.String |
filterSymbols |
|
Returns
GetConnectorDefaults(Object)
Helps to return the default properties of connector
Declaration
public SymbolPaletteBuilder GetConnectorDefaults(object getConnectorDefaults)
Parameters
Type |
Name |
Description |
System.Object |
getConnectorDefaults |
|
Returns
GetConnectorDefaults(String)
Helps to return the default properties of connector
Declaration
public SymbolPaletteBuilder GetConnectorDefaults(string getConnectorDefaults)
Parameters
Type |
Name |
Description |
System.String |
getConnectorDefaults |
|
Returns
GetNodeDefaults(Object)
Helps to return the default properties of node
Declaration
public SymbolPaletteBuilder GetNodeDefaults(object getNodeDefaults)
Parameters
Type |
Name |
Description |
System.Object |
getNodeDefaults |
|
Returns
GetNodeDefaults(String)
Helps to return the default properties of node
Declaration
public SymbolPaletteBuilder GetNodeDefaults(string getNodeDefaults)
Parameters
Type |
Name |
Description |
System.String |
getNodeDefaults |
|
Returns
GetSymbolInfo(Object)
Declaration
public SymbolPaletteBuilder GetSymbolInfo(object getSymbolInfo)
Parameters
Type |
Name |
Description |
System.Object |
getSymbolInfo |
|
Returns
GetSymbolInfo(String)
Declaration
public SymbolPaletteBuilder GetSymbolInfo(string getSymbolInfo)
Parameters
Type |
Name |
Description |
System.String |
getSymbolInfo |
|
Returns
GetSymbolTemplate(Object)
Defines the content of a symbol
Declaration
public SymbolPaletteBuilder GetSymbolTemplate(object getSymbolTemplate)
Parameters
Type |
Name |
Description |
System.Object |
getSymbolTemplate |
|
Returns
GetSymbolTemplate(String)
Defines the content of a symbol
Declaration
public SymbolPaletteBuilder GetSymbolTemplate(string getSymbolTemplate)
Parameters
Type |
Name |
Description |
System.String |
getSymbolTemplate |
|
Returns
Height(Double)
Defines the height of the symbol palette
Declaration
public SymbolPaletteBuilder Height(double height)
Parameters
Type |
Name |
Description |
System.Double |
height |
|
Returns
Height(String)
Defines the height of the symbol palette
Declaration
public SymbolPaletteBuilder Height(string height)
Parameters
Type |
Name |
Description |
System.String |
height |
|
Returns
HtmlAttributes(Object)
Allows additional HTML attributes such as title, name, etc., and
accepts n number of attributes in a key-value pair format.
Declaration
public SymbolPaletteBuilder HtmlAttributes(object htmlAttributes)
Parameters
Type |
Name |
Description |
System.Object |
htmlAttributes |
|
Returns
IgnoreSymbolsOnSearch(String[])
Defines the symbols to be added in search palette
Declaration
public SymbolPaletteBuilder IgnoreSymbolsOnSearch(string[] ignoreSymbolsOnSearch)
Parameters
Type |
Name |
Description |
System.String[] |
ignoreSymbolsOnSearch |
|
Returns
Locale(String)
Overrides the global culture and localization value for this component. Default global culture is 'en-US'.
Declaration
public SymbolPaletteBuilder Locale(string locale)
Parameters
Type |
Name |
Description |
System.String |
locale |
|
Returns
NodeDefaults(Object)
Helps to return the default properties of node
Declaration
public SymbolPaletteBuilder NodeDefaults(object nodeDefaults)
Parameters
Type |
Name |
Description |
System.Object |
nodeDefaults |
|
Returns
PaletteExpanding(String)
Triggers when the icon is expanded
Declaration
public SymbolPaletteBuilder PaletteExpanding(string paletteExpanding)
Parameters
Type |
Name |
Description |
System.String |
paletteExpanding |
|
Returns
Palettes(Action<SymbolPalettePaletteBuilder>)
Declaration
public SymbolPaletteBuilder Palettes(Action<SymbolPalettePaletteBuilder> palettes)
Parameters
Returns
Palettes(List<SymbolPalettePalette>)
Defines the collection of symbol groups
Declaration
public SymbolPaletteBuilder Palettes(List<SymbolPalettePalette> palettes)
Parameters
Returns
PaletteSelectionChange(String)
Triggers after the selection changes in the symbol palette
Declaration
public SymbolPaletteBuilder PaletteSelectionChange(string paletteSelectionChange)
Parameters
Type |
Name |
Description |
System.String |
paletteSelectionChange |
|
Returns
Render()
Declaration
public HtmlString Render()
Returns
Type |
Description |
Microsoft.AspNetCore.Html.HtmlString |
|
SymbolDragSize(Object)
Defines the size of a drop symbol
Declaration
public SymbolPaletteBuilder SymbolDragSize(object symbolDragSize)
Parameters
Type |
Name |
Description |
System.Object |
symbolDragSize |
|
Returns
SymbolHeight(Double)
Defines the height of the symbol
Declaration
public SymbolPaletteBuilder SymbolHeight(double symbolHeight)
Parameters
Type |
Name |
Description |
System.Double |
symbolHeight |
|
Returns
SymbolInfo(Object)
Defines the size, appearance and description of a symbol
Declaration
public SymbolPaletteBuilder SymbolInfo(object symbolInfo)
Parameters
Type |
Name |
Description |
System.Object |
symbolInfo |
|
Returns
SymbolMargin(SymbolPaletteMargin)
Defines the space to be left around a symbol
Declaration
public SymbolPaletteBuilder SymbolMargin(SymbolPaletteMargin symbolMargin)
Parameters
Returns
SymbolMargin(Action<SymbolPaletteMarginBuilder>)
Declaration
public SymbolPaletteBuilder SymbolMargin(Action<SymbolPaletteMarginBuilder> symbolMargin)
Parameters
Returns
SymbolPreview(SymbolPaletteSymbolPreview)
Defines the size and position of the symbol preview
Declaration
public SymbolPaletteBuilder SymbolPreview(SymbolPaletteSymbolPreview symbolPreview)
Parameters
Returns
SymbolPreview(Action<SymbolPaletteSymbolPreviewBuilder>)
Declaration
public SymbolPaletteBuilder SymbolPreview(Action<SymbolPaletteSymbolPreviewBuilder> symbolPreview)
Parameters
Returns
SymbolWidth(Double)
Defines the width of the symbol
Declaration
public SymbolPaletteBuilder SymbolWidth(double symbolWidth)
Parameters
Type |
Name |
Description |
System.Double |
symbolWidth |
|
Returns
Width(Double)
Defines the width of the symbol palette
Declaration
public SymbolPaletteBuilder Width(double width)
Parameters
Type |
Name |
Description |
System.Double |
width |
|
Returns
Width(String)
Defines the width of the symbol palette
Declaration
public SymbolPaletteBuilder Width(string width)
Parameters
Type |
Name |
Description |
System.String |
width |
|
Returns