Class SymbolPalettePropertiesBuilder

Implementation of symbolpalette properties using view formatting

Inheritance

System.Object

SymbolPalettePropertiesBuilder

Implements

IPropertiesBuilder

System.Web.IHtmlString

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Syncfusion.JavaScript.DataVisualization

Assembly: Syncfusion.EJ.dll

Syntax

public class SymbolPalettePropertiesBuilder : IPropertiesBuilder, IHtmlString

Constructors

SymbolPalettePropertiesBuilder()

Declaration

public SymbolPalettePropertiesBuilder()

SymbolPalettePropertiesBuilder(SymbolPalette)

Declaration

public SymbolPalettePropertiesBuilder(SymbolPalette symbolPalette)

Parameters

Type	Name	Description
SymbolPalette	symbolPalette

Fields

symbolPalette

Declaration

public SymbolPalette symbolPalette

Field Value

Type	Description
SymbolPalette

Methods

AllowDrag(Boolean)

Gets or sets the whether the symbols can be dragged from palette or not

Declaration

public SymbolPalettePropertiesBuilder AllowDrag(bool allowDrag)

Parameters

Type	Name	Description
System.Boolean	allowDrag

Returns

Type	Description
SymbolPalettePropertiesBuilder	true

Examples

@{
   Html.EJ().SymbolPalette("SymbolPalette").AllowDrag(false);
}

CssClass(String)

Gets or sets the Custom style of the symbol palette

Declaration

public SymbolPalettePropertiesBuilder CssClass(string cssClass)

Parameters

Type	Name	Description
System.String	cssClass

Returns

Type	Description
SymbolPalettePropertiesBuilder	String.Empty

Examples

@{
   Html.EJ().SymbolPalette("SymbolPalette").CssClass("class name");
}

DiagramId(String)

Gets or sets the Id of the diagram, over which the symbols will be dropped

Declaration

public SymbolPalettePropertiesBuilder DiagramId(string diagramId)

Parameters

Type	Name	Description
System.String	diagramId

Returns

Type	Description
SymbolPalettePropertiesBuilder	String.Empty

Examples

@{
   Html.EJ().SymbolPalette("SymbolPalette").DiagramId("Diagram");
}

HeaderHeight(Int32)

Gets or sets the height of the palette headers

Declaration

public SymbolPalettePropertiesBuilder HeaderHeight(int headerHeight)

Parameters

Type	Name	Description
System.Int32	headerHeight

Returns

Type	Description
SymbolPalettePropertiesBuilder	30

Examples

@{
   Html.EJ().SymbolPalette("SymbolPalette").HeaderHeight(40);
}

Height(String)

Gets or sets the height of the symbol palette

Declaration

public SymbolPalettePropertiesBuilder Height(string height)

Parameters

Type	Name	Description
System.String	height

Returns

Type	Description
SymbolPalettePropertiesBuilder	400

Examples

@{
   Html.EJ().SymbolPalette("SymbolPalette").Height("250px");
}

PaletteItemHeight(Int32)

Gets or sets the height of the palette items

Declaration

public SymbolPalettePropertiesBuilder PaletteItemHeight(int paletteItemHeight)

Parameters

Type	Name	Description
System.Int32	paletteItemHeight

Returns

Type	Description
SymbolPalettePropertiesBuilder	50

Examples

@{
   Html.EJ().SymbolPalette("SymbolPalette").PaletteItemHeight(60);
}

PaletteItemWidth(Int32)

Gets or sets the width of the palette items

Declaration

public SymbolPalettePropertiesBuilder PaletteItemWidth(int paletteItemWidth)

Parameters

Type	Name	Description
System.Int32	paletteItemWidth

Returns

Type	Description
SymbolPalettePropertiesBuilder	50

Examples

@{
   Html.EJ().SymbolPalette("SymbolPalette").PaletteItemWidth(60);
}

Palettes(Action<ISymbolPalettesAdder>)

Declaration

public virtual SymbolPalettePropertiesBuilder Palettes(Action<ISymbolPalettesAdder> palettes)

Parameters

Type	Name	Description
System.Action<ISymbolPalettesAdder>	palettes

Returns

Type	Description
SymbolPalettePropertiesBuilder

PreviewHeight(Int32)

Gets or sets the preview height of the symbols

Declaration

public SymbolPalettePropertiesBuilder PreviewHeight(int previewHeight)

Parameters

Type	Name	Description
System.Int32	previewHeight

Returns

Type	Description
SymbolPalettePropertiesBuilder	100

Examples

@{
   Html.EJ().SymbolPalette("SymbolPalette").PreviewHeight(60);
}

PreviewWidth(Int32)

Gets or sets the width of the symbol previews

Declaration

public SymbolPalettePropertiesBuilder PreviewWidth(int previewWidth)

Parameters

Type	Name	Description
System.Int32	previewWidth

Returns

Type	Description
SymbolPalettePropertiesBuilder	100

Examples

@{
   Html.EJ().SymbolPalette("SymbolPalette").PreviewWidth(60);
}

Render()

Declaration

public void Render()

SelectedPaletteName(String)

Gets or sets the palette name could be selected.

Declaration

public SymbolPalettePropertiesBuilder SelectedPaletteName(string selectedPaletteName)

Parameters

Type	Name	Description
System.String	selectedPaletteName

Returns

Type	Description
SymbolPalettePropertiesBuilder	String.Empty

Examples

@{
   Html.EJ().SymbolPalette("SymbolPalette").SelectedPaletteName("FlowShapes");
}

ShowPaletteItemText(Boolean)

Gets or sets the the boolean value ,that nable or disable the palette item text

Declaration

public SymbolPalettePropertiesBuilder ShowPaletteItemText(bool showPaletteItemText)

Parameters

Type	Name	Description
System.Boolean	showPaletteItemText

Returns

Type	Description
SymbolPalettePropertiesBuilder	true

Examples

@{
   Html.EJ().SymbolPalette("SymbolPalette").ShowPaletteItemText(false);
}

ToHtmlString()

Declaration

public string ToHtmlString()

Returns

Type	Description
System.String

Width(String)

Gets or sets the width of the symbol palette

Declaration

public SymbolPalettePropertiesBuilder Width(string width)

Parameters

Type	Name	Description
System.String	width

Returns

Type	Description
SymbolPalettePropertiesBuilder	250

Examples

@{
   Html.EJ().SymbolPalette("SymbolPalette").Width("250px");
}

Implements

IPropertiesBuilder

System.Web.IHtmlString