menu

ASP.NET Core - EJ2

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class SymbolPaletteBuilder - API Reference

    Show / Hide Table of Contents

    Class SymbolPaletteBuilder

    Inheritance
    System.Object
    ControlBuilder
    SymbolPaletteBuilder
    Inherited Members
    ControlBuilder.Context
    Namespace: Syncfusion.EJ2.Diagrams
    Assembly: Syncfusion.EJ2.dll
    Syntax
    public class SymbolPaletteBuilder : ControlBuilder

    Constructors

    SymbolPaletteBuilder()

    Declaration
    public SymbolPaletteBuilder()

    SymbolPaletteBuilder(SymbolPalette)

    Declaration
    public SymbolPaletteBuilder(SymbolPalette model)
    Parameters
    Type Name Description
    SymbolPalette model

    Fields

    model

    Declaration
    public SymbolPalette model
    Field Value
    Type Description
    SymbolPalette

    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
    ControlBuilder.Output

    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
    Type Description
    SymbolPaletteBuilder

    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
    Type Description
    SymbolPaletteBuilder

    ConnectorDefaults(Object)

    Helps to return the default properties of connectors

    Declaration
    public SymbolPaletteBuilder ConnectorDefaults(object connectorDefaults)
    Parameters
    Type Name Description
    System.Object connectorDefaults
    Returns
    Type Description
    SymbolPaletteBuilder

    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
    Type Description
    SymbolPaletteBuilder

    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
    Type Description
    SymbolPaletteBuilder

    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
    Type Description
    SymbolPaletteBuilder

    EnableSearch(Boolean)

    Enables/Disables search option in symbol palette

    Declaration
    public SymbolPaletteBuilder EnableSearch(bool enableSearch = true)
    Parameters
    Type Name Description
    System.Boolean enableSearch
    Returns
    Type Description
    SymbolPaletteBuilder

    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
    Type Description
    SymbolPaletteBuilder

    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
    Type Description
    SymbolPaletteBuilder

    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
    Type Description
    SymbolPaletteBuilder

    GetConnectorDefaults(Object)

    Helps to return the default properties of connector

    Declaration
    public SymbolPaletteBuilder GetConnectorDefaults(object getConnectorDefaults)
    Parameters
    Type Name Description
    System.Object getConnectorDefaults
    Returns
    Type Description
    SymbolPaletteBuilder

    GetConnectorDefaults(String)

    Helps to return the default properties of connector

    Declaration
    public SymbolPaletteBuilder GetConnectorDefaults(string getConnectorDefaults)
    Parameters
    Type Name Description
    System.String getConnectorDefaults
    Returns
    Type Description
    SymbolPaletteBuilder

    GetNodeDefaults(Object)

    Helps to return the default properties of node

    Declaration
    public SymbolPaletteBuilder GetNodeDefaults(object getNodeDefaults)
    Parameters
    Type Name Description
    System.Object getNodeDefaults
    Returns
    Type Description
    SymbolPaletteBuilder

    GetNodeDefaults(String)

    Helps to return the default properties of node

    Declaration
    public SymbolPaletteBuilder GetNodeDefaults(string getNodeDefaults)
    Parameters
    Type Name Description
    System.String getNodeDefaults
    Returns
    Type Description
    SymbolPaletteBuilder

    GetSymbolInfo(Object)

    Declaration
    public SymbolPaletteBuilder GetSymbolInfo(object getSymbolInfo)
    Parameters
    Type Name Description
    System.Object getSymbolInfo
    Returns
    Type Description
    SymbolPaletteBuilder

    GetSymbolInfo(String)

    Declaration
    public SymbolPaletteBuilder GetSymbolInfo(string getSymbolInfo)
    Parameters
    Type Name Description
    System.String getSymbolInfo
    Returns
    Type Description
    SymbolPaletteBuilder

    GetSymbolTemplate(Object)

    Defines the content of a symbol

    Declaration
    public SymbolPaletteBuilder GetSymbolTemplate(object getSymbolTemplate)
    Parameters
    Type Name Description
    System.Object getSymbolTemplate
    Returns
    Type Description
    SymbolPaletteBuilder

    GetSymbolTemplate(String)

    Defines the content of a symbol

    Declaration
    public SymbolPaletteBuilder GetSymbolTemplate(string getSymbolTemplate)
    Parameters
    Type Name Description
    System.String getSymbolTemplate
    Returns
    Type Description
    SymbolPaletteBuilder

    Height(Double)

    Defines the height of the symbol palette

    Declaration
    public SymbolPaletteBuilder Height(double height)
    Parameters
    Type Name Description
    System.Double height
    Returns
    Type Description
    SymbolPaletteBuilder

    Height(String)

    Defines the height of the symbol palette

    Declaration
    public SymbolPaletteBuilder Height(string height)
    Parameters
    Type Name Description
    System.String height
    Returns
    Type Description
    SymbolPaletteBuilder

    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
    Type Description
    SymbolPaletteBuilder

    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
    Type Description
    SymbolPaletteBuilder

    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
    Type Description
    SymbolPaletteBuilder

    NodeDefaults(Object)

    Helps to return the default properties of node

    Declaration
    public SymbolPaletteBuilder NodeDefaults(object nodeDefaults)
    Parameters
    Type Name Description
    System.Object nodeDefaults
    Returns
    Type Description
    SymbolPaletteBuilder

    PaletteExpanding(String)

    Triggers when the icon is expanded

    Declaration
    public SymbolPaletteBuilder PaletteExpanding(string paletteExpanding)
    Parameters
    Type Name Description
    System.String paletteExpanding
    Returns
    Type Description
    SymbolPaletteBuilder

    Palettes(Action<SymbolPalettePaletteBuilder>)

    Declaration
    public SymbolPaletteBuilder Palettes(Action<SymbolPalettePaletteBuilder> palettes)
    Parameters
    Type Name Description
    System.Action<SymbolPalettePaletteBuilder> palettes
    Returns
    Type Description
    SymbolPaletteBuilder

    Palettes(List<SymbolPalettePalette>)

    Defines the collection of symbol groups

    Declaration
    public SymbolPaletteBuilder Palettes(List<SymbolPalettePalette> palettes)
    Parameters
    Type Name Description
    System.Collections.Generic.List<SymbolPalettePalette> palettes
    Returns
    Type Description
    SymbolPaletteBuilder

    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
    Type Description
    SymbolPaletteBuilder

    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
    Type Description
    SymbolPaletteBuilder

    SymbolHeight(Double)

    Defines the height of the symbol

    Declaration
    public SymbolPaletteBuilder SymbolHeight(double symbolHeight)
    Parameters
    Type Name Description
    System.Double symbolHeight
    Returns
    Type Description
    SymbolPaletteBuilder

    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
    Type Description
    SymbolPaletteBuilder

    SymbolMargin(SymbolPaletteMargin)

    Defines the space to be left around a symbol

    Declaration
    public SymbolPaletteBuilder SymbolMargin(SymbolPaletteMargin symbolMargin)
    Parameters
    Type Name Description
    SymbolPaletteMargin symbolMargin
    Returns
    Type Description
    SymbolPaletteBuilder

    SymbolMargin(Action<SymbolPaletteMarginBuilder>)

    Declaration
    public SymbolPaletteBuilder SymbolMargin(Action<SymbolPaletteMarginBuilder> symbolMargin)
    Parameters
    Type Name Description
    System.Action<SymbolPaletteMarginBuilder> symbolMargin
    Returns
    Type Description
    SymbolPaletteBuilder

    SymbolPreview(SymbolPaletteSymbolPreview)

    Defines the size and position of the symbol preview

    Declaration
    public SymbolPaletteBuilder SymbolPreview(SymbolPaletteSymbolPreview symbolPreview)
    Parameters
    Type Name Description
    SymbolPaletteSymbolPreview symbolPreview
    Returns
    Type Description
    SymbolPaletteBuilder

    SymbolPreview(Action<SymbolPaletteSymbolPreviewBuilder>)

    Declaration
    public SymbolPaletteBuilder SymbolPreview(Action<SymbolPaletteSymbolPreviewBuilder> symbolPreview)
    Parameters
    Type Name Description
    System.Action<SymbolPaletteSymbolPreviewBuilder> symbolPreview
    Returns
    Type Description
    SymbolPaletteBuilder

    SymbolWidth(Double)

    Defines the width of the symbol

    Declaration
    public SymbolPaletteBuilder SymbolWidth(double symbolWidth)
    Parameters
    Type Name Description
    System.Double symbolWidth
    Returns
    Type Description
    SymbolPaletteBuilder

    Width(Double)

    Defines the width of the symbol palette

    Declaration
    public SymbolPaletteBuilder Width(double width)
    Parameters
    Type Name Description
    System.Double width
    Returns
    Type Description
    SymbolPaletteBuilder

    Width(String)

    Defines the width of the symbol palette

    Declaration
    public SymbolPaletteBuilder Width(string width)
    Parameters
    Type Name Description
    System.String width
    Returns
    Type Description
    SymbolPaletteBuilder
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved