Class PaletteGroupView

Displays the symbol models belonging to a symbol palette in a GroupView.

Inheritance
System.Object
BaseControl
GroupView
PaletteGroupView
Inherited Members
Namespace: Syncfusion.Windows.Forms.Diagram.Controls
Assembly: Syncfusion.Diagram.Windows.dll
Syntax
public class PaletteGroupView : GroupView, IThemeProvider, IVisualStyle, IDisposable, IIntegratedScrollClient, IGroupViewDesignerInvoke
Remarks

This class is derived from the Syncfusion.Windows.Forms.Tools.GroupView class. A GroupView is a control that contains a list of icons and labels that can be hosted in a GroupBar (Outlook bar).

This class provides an implementation that displays a list of symbol models that belong to a given symbol palette. Symbol models can be dragged from this control onto diagrams.

PaletteGroupBar

Constructors

PaletteGroupView()

Initializes a new instance of the PaletteGroupView class.

Declaration
public PaletteGroupView()

PaletteGroupView(IContainer)

Initializes a new instance of the PaletteGroupView class.

Declaration
public PaletteGroupView(IContainer container)
Parameters
Type Name Description
System.ComponentModel.IContainer container

The container.

Properties

Diagram

Gets or sets the diagram control.

Declaration
public Diagram Diagram { get; set; }
Property Value
Type
Diagram

DragNodeCueEnabled

Gets or sets a value indicating whether dragged node cue is enabled or not.

Declaration
public bool DragNodeCueEnabled { get; set; }
Property Value
Type
System.Boolean

EditMode

Gets or sets a value indicating whether or not the symbols can be dragged from the palette onto a diagram.

Declaration
public bool EditMode { get; set; }
Property Value
Type
System.Boolean
Remarks

When this property is set to True, the palette is being edited and symbols cannot be dragged onto a diagram. The Symbol Designer sets this flag to True. The typical setting for an application is False, which means that the palette is not being edited and symbols may be dragged onto a diagram.

GroupViewItems

Gets or sets the collection of GroupViewItem objects in the control.

Declaration
public GroupView.GroupViewItemCollection GroupViewItems { get; set; }
Property Value
Type Description
GroupView.GroupViewItemCollection

An instance of the GroupView.GroupViewItemCollection type.

LargeImageList

Gets or sets the image list containing the large (32x32) images.

Declaration
public ImageList LargeImageList { get; set; }
Property Value
Type Description
System.Windows.Forms.ImageList

An ImageList type.
Remarks

SmallImageList

Magnification

Gets or sets drag cue's magnification (zoom) values on a scale of 1 to n.

Declaration
public float Magnification { get; set; }
Property Value
Type
System.Single

Palette

Gets or sets reference to the symbol palette displayed by this control.

Declaration
public SymbolPalette Palette { get; set; }
Property Value
Type
SymbolPalette

PaletteItemSize

Declaration
public Size PaletteItemSize { get; set; }
Property Value
Type
System.Drawing.Size

SelectedNode

Gets the selected node.

Declaration
public Node SelectedNode { get; }
Property Value
Type Description
Node

The selected node.

ShowDragNodeCue

Gets or sets a value indicating whether dragged node cue is visible or not.

Declaration
public bool ShowDragNodeCue { get; set; }
Property Value
Type
System.Boolean

SmallImageList

Gets or sets the image list containing the small (16x16) images.

Declaration
public ImageList SmallImageList { get; set; }
Property Value
Type Description
System.Windows.Forms.ImageList

An ImageList type.
Remarks

LargeImageList

Methods

Dispose(Boolean)

Clean up any resources being used.

Declaration
protected override void Dispose(bool bdispose)
Parameters
Type Name Description
System.Boolean bdispose

true to release both managed and unmanaged resources; false to release only unmanaged resources.
Overrides

LoadPalette(SymbolPalette)

Loads the given symbol palette into this control.

Declaration
public bool LoadPalette(SymbolPalette symbolPalette)
Parameters
Type Name Description
SymbolPalette symbolPalette

SymbolPalette to load.
Returns
Type Description
System.Boolean

True if successful; otherwise False.

LoadPalette(Byte[])

Loads a symbol palette from memory.

Declaration
public bool LoadPalette(byte[] strmData)
Parameters
Type Name Description
System.Byte[] strmData

Array of bytes containing serialized symbol palette.
Returns
Type Description
System.Boolean

True if successful; otherwise False.

LoadPalette(Assembly, String, String)

Loads a symbol palette from a resource file.

Declaration
public bool LoadPalette(Assembly assembly, string baseName, string resName)
Parameters
Type Name Description
System.Reflection.Assembly assembly

Assembly containing the symbol palette.
System.String baseName

Base name of resource.
System.String resName

Name of resource.
Returns
Type Description
System.Boolean

True if successful; otherwise False.

LoadPalette(String)

Loads a symbol palette from a file.

Declaration
public bool LoadPalette(string filename)
Parameters
Type Name Description
System.String filename

Name of file to load.
Returns
Type Description
System.Boolean

True if successful; otherwise False.
Remarks

Deserializes a symbol palette from disk and loads it into this control.

OnGiveFeedback(GiveFeedbackEventArgs)

Called when a give feedback event is received.

Declaration
protected override void OnGiveFeedback(GiveFeedbackEventArgs evtArgs)
Parameters
Type Name Description
System.Windows.Forms.GiveFeedbackEventArgs evtArgs

Event arguments.

OnGroupViewItemSelected(EventArgs)

Called when a item selected event is received.

Declaration
protected override void OnGroupViewItemSelected(EventArgs arg)
Parameters
Type Name Description
System.EventArgs arg

Event arguments.
Overrides

OnMouseDown(MouseEventArgs)

Called when a mouse down event is received.

Declaration
protected override void OnMouseDown(MouseEventArgs evtArgs)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs evtArgs

Event arguments.
Overrides
Remarks

If EditMode is enabled, then this method starts a drag-and-drop operation.

OnMouseMove(MouseEventArgs)

Called when a mouse move event is received.

Declaration
protected override void OnMouseMove(MouseEventArgs evtArgs)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs evtArgs

Event arguments.
Overrides
Remarks

If a drag-and-drop operation has been started with a mouse down, this method calls the System.Windows.Forms.Control.DoDragDrop method.

OnMouseDown(MouseEventArgs)

OnMouseUp(MouseEventArgs)

Called when a mouse up event is received.

Declaration
protected override void OnMouseUp(MouseEventArgs evtArgs)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs evtArgs

Event arguments.
Overrides

OnQueryContinueDrag(QueryContinueDragEventArgs)

Called when a query continue drag event is received.

Declaration
protected override void OnQueryContinueDrag(QueryContinueDragEventArgs args)
Parameters
Type Name Description
System.Windows.Forms.QueryContinueDragEventArgs args

Event arguments.

SelectNode(Node)

Set the selected symbol model to the one matching the given symbol model name.

Declaration
public void SelectNode(Node node)
Parameters
Type Name Description
Node node

Node to select.

WndProc(ref Message)

Overriden. WndProc.

Declaration
protected override void WndProc(ref Message m)
Parameters
Type Name Description
System.Windows.Forms.Message m

The message.
Overrides

Events

DoubleClick

Occurs when the control is double-clicked.

Declaration
public event EventHandler DoubleClick
Event Type
Type
System.EventHandler

NodeSelected

Fired when the user selects a symbol model icon in a palette groupview component.

Declaration
public event NodeEventHandler NodeSelected
Event Type
Type
NodeEventHandler

Implements

System.IDisposable