menu

Blazor

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

    Show / Hide Table of Contents

    Class PaletteExpandingEventArgs

    Notifies when the palette items are expanded or collapsed in the symbol palette.

    Inheritance
    System.Object
    PaletteExpandingEventArgs
    Namespace: Syncfusion.Blazor.Diagram.SymbolPalette
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class PaletteExpandingEventArgs : Object
    Examples
    <SfSymbolPaletteComponent  Expanding="OnExpanding">
    </SfSymbolPaletteComponent>
    private void OnExpanding(PaletteExpandingEventArgs args)
    {
        if (args.Cancel)
        {
            args.Cancel = true;
        }
    }

    Constructors

    PaletteExpandingEventArgs()

    Declaration
    public PaletteExpandingEventArgs()

    Properties

    Cancel

    Gets or sets that indicate whether the palette item expand or collapse is to be canceled.

    Declaration
    public bool Cancel { get; set; }
    Property Value
    Type Description
    System.Boolean
    Examples
    <SfSymbolPaletteComponent  Expanding="OnExpanding">
    </SfSymbolPaletteComponent>
    private void OnExpanding(PaletteExpandingEventArgs args)
    {
        if (args.Cancel)
        {
            args.Cancel = true;
        }
    }

    Index

    Represents the index of the palette item being selected.

    Declaration
    public int Index { get; }
    Property Value
    Type Description
    System.Int32
    Examples
    <SfSymbolPaletteComponent  Expanding="OnExpanding">
    </SfSymbolPaletteComponent>
    private void OnExpanding(PaletteExpandingEventArgs args)
    {
      args.Index = 2;
    }

    IsExpanded

    Represents the value if the palette item is expanded.

    Declaration
    public bool IsExpanded { get; }
    Property Value
    Type Description
    System.Boolean

    true, The palette item is expanded; Otherwise false.The default value is false.

    Examples
    <SfSymbolPaletteComponent  Expanding="OnExpanding">
    </SfSymbolPaletteComponent>
    private void OnExpanding(PaletteExpandingEventArgs args)
    {
      args.IsExpanded = true;
    }

    Palette

    Represents the properties of the palette item being selected.

    Declaration
    public Palette Palette { get; }
    Property Value
    Type Description
    Palette
    Examples
    <SfSymbolPaletteComponent  Expanding="OnExpanding">
    </SfSymbolPaletteComponent>
    private void OnExpanding(PaletteExpandingEventArgs args)
    {
      args.Palette= new Palette(){};
    }
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved