Class Stencil

Inheritance
System.Object
Stencil
Namespace: Syncfusion.UI.Xaml.Diagram.Stencil
Assembly: Syncfusion.SfDiagram.WPF.dll
Syntax
public class Stencil : Control

Constructors

Stencil()

Initializes a new instance of the Stencil class.

Declaration
public Stencil()

Fields

CategoriesProperty

Identifies the Categories property.

Declaration
public static DependencyProperty CategoriesProperty
Field Value
Type Description
System.Windows.DependencyProperty

ConstraintsProperty

Identifies the Syncfusion.UI.Xaml.Diagram.Stencil.Constraints dependency property.

Declaration
public static DependencyProperty ConstraintsProperty
Field Value
Type Description
System.Windows.DependencyProperty

ExpandModeProperty

Identifies the Syncfusion.UI.Xaml.Diagram.Stencil.ExpandMode dependency property.

Declaration
public static DependencyProperty ExpandModeProperty
Field Value
Type Description
System.Windows.DependencyProperty

HeaderVisibilityProperty

Identifies the Syncfusion.UI.Xaml.Diagram.Stencil.HeaderVisibility dependency property.

Declaration
public static DependencyProperty HeaderVisibilityProperty
Field Value
Type Description
System.Windows.DependencyProperty

SelectedFilterProperty

Identifies the Syncfusion.UI.Xaml.Diagram.Stencil.SelectedFilter dependency property.

Declaration
public static DependencyProperty SelectedFilterProperty
Field Value
Type Description
System.Windows.DependencyProperty

SelectedSymbolProperty

Identifies the Syncfusion.UI.Xaml.Diagram.Stencil.SelectedSymbol dependency property.

Declaration
public static DependencyProperty SelectedSymbolProperty
Field Value
Type Description
System.Windows.DependencyProperty

SymbolFiltersProperty

Identifies the Syncfusion.UI.Xaml.Diagram.Stencil.SymbolFilters dependency property.

Declaration
public static DependencyProperty SymbolFiltersProperty
Field Value
Type Description
System.Windows.DependencyProperty

SymbolGroupProperty

Declaration
public static DependencyProperty SymbolGroupProperty
Field Value
Type Description
System.Windows.DependencyProperty

SymbolGroupsProperty

Identifies the Syncfusion.UI.Xaml.Diagram.Stencil.SymbolGroups dependency property.

Declaration
public static DependencyProperty SymbolGroupsProperty
Field Value
Type Description
System.Windows.DependencyProperty

SymbolPreviewProperty

Identifies the Syncfusion.UI.Xaml.Diagram.Stencil.SymbolPreview dependency property.

Declaration
public static DependencyProperty SymbolPreviewProperty
Field Value
Type Description
System.Windows.DependencyProperty

SymbolSourceProperty

Identifies the Syncfusion.UI.Xaml.Diagram.Stencil.SymbolSource dependency property.

Declaration
public static DependencyProperty SymbolSourceProperty
Field Value
Type Description
System.Windows.DependencyProperty

Properties

Categories

Gets or sets the stencil groups collection.

Declaration
public StencilCategoryCollection Categories { get; set; }
Property Value
Type Description
StencilCategoryCollection

Constraints

Gets or sets the default behaviours of stencil.

Declaration
public StencilConstraints Constraints { get; set; }
Property Value
Type Description
StencilConstraints

ExpandMode

Gets or sets a value that indicates the number of symbol group expanded in stencil.

Declaration
public ExpandMode ExpandMode { get; set; }
Property Value
Type Description
ExpandMode

HeaderVisibility

Gets or sets the header visibility of the symbol groups in stencil.

Declaration
public Visibility HeaderVisibility { get; set; }
Property Value
Type Description
System.Windows.Visibility

KnownTypes

Gets or sets a collection of known types that may be present in the stencil for serialization.

Declaration
public GetTypes KnownTypes { get; set; }
Property Value
Type Description
GetTypes

SelectedFilter

Gets or sets a selected symbol filter in stencil.

Declaration
public SymbolFilterProvider SelectedFilter { get; set; }
Property Value
Type Description
SymbolFilterProvider

SelectedSymbol

Gets or sets a selected symbol in stencil.

Declaration
public Symbol SelectedSymbol { get; set; }
Property Value
Type Description
Symbol

SymbolFilters

Gets or sets a collection used to generate the SymbolFilterProvider in stencil.

Declaration
public SymbolFilters SymbolFilters { get; set; }
Property Value
Type Description
SymbolFilters

SymbolGroups

Gets or sets a collection used to generate the SymbolGroupProvider in stencil.

Declaration
public SymbolGroups SymbolGroups { get; set; }
Property Value
Type Description
SymbolGroups

SymbolPreview

Gets or sets the preview of symbol when drag from stencil.

Declaration
public ContentPresenter SymbolPreview { get; set; }
Property Value
Type Description
System.Windows.Controls.ContentPresenter

SymbolSource

Gets or sets a collection used to generate the symbol in stencil.

Declaration
public object SymbolSource { get; set; }
Property Value
Type Description
System.Object

Methods

CanAddSymbol(String, String)

Virtual method to decide whether the symbol can be added into collection or not.

Declaration
protected virtual bool CanAddSymbol(string SymbolName, string CategoryName)
Parameters
Type Name Description
System.String SymbolName

Name of the symbol.
System.String CategoryName

Name of the symbol category.
Returns
Type Description
System.Boolean

Returns the bool.
Remarks

This virtual method is applicable only when category collection is provided.

GetSymbolForItemOverride(Object)

Creates the view that is used to represent the given symbol.

Declaration
public virtual Symbol GetSymbolForItemOverride(object item)
Parameters
Type Name Description
System.Object item
Returns
Type Description
Symbol

GetSymbolGroupForItemOverride(Object)

Creates the view that is used to represent the given symbol group.

Declaration
public virtual SymbolGroup GetSymbolGroupForItemOverride(object item)
Parameters
Type Name Description
System.Object item
Returns
Type Description
SymbolGroup

Load(Stream)

Declaration
public void Load(Stream stream)
Parameters
Type Name Description
System.IO.Stream stream

OnApplyTemplate()

When overridden in a derived class, is invoked whenever application code or internal processes call System.Windows.FrameworkElement.ApplyTemplate.

Declaration
public override void OnApplyTemplate()

OnSymbolsLoaded(SymbolsLoadedEventArgs)

Invokd when symbols are loaded into stencil.

Declaration
public void OnSymbolsLoaded(SymbolsLoadedEventArgs args)
Parameters
Type Name Description
SymbolsLoadedEventArgs args

Data for loaded symbols.

PrepareDragDropPreview()

Method to customize the preview of symbol while dropping.

Declaration
protected virtual void PrepareDragDropPreview()

PrepareSymbolViewModel(Object, String, String)

Virtual method to override the default category collection, customize the symbol and its values.

Declaration
protected virtual object PrepareSymbolViewModel(object Item, string SymbolName, string CategoryName)
Parameters
Type Name Description
System.Object Item

Symbol of the collection
System.String SymbolName

Name of the symbol
System.String CategoryName

name of the symnol category
Returns
Type Description
System.Object

Returns the symbol of the collection
Remarks

This virtual method is applicable only when category collection is provided.

Save(Stream)

Saves this Stencil to the specified stream.

Declaration
public void Save(Stream stream)
Parameters
Type Name Description
System.IO.Stream stream

The Stream where the stencil will be saved..

SearchSymbol(String)

Search a specific symbol in stencil.

Declaration
public void SearchSymbol(string str)
Parameters
Type Name Description
System.String str

Symbol key.

Events

Collapsed

Occurs when collapse the symbol group.

Declaration
public event SymbolGroupCollapseEventHandler Collapsed
Event Type
Type Description
SymbolGroupCollapseEventHandler

Expanded

Occurs when expand the symbol group.

Declaration
public event SymbolGroupExpandEventHandler Expanded
Event Type
Type Description
SymbolGroupExpandEventHandler

SymbolsLoaded

Occurs when the symbol is laid out, rendered, and ready for interaction

Declaration
public event SymbolsLoadedEventHandler SymbolsLoaded
Event Type
Type Description
SymbolsLoadedEventHandler

Extension Methods