Skip to main content
A newer version of this page is available. .

DiagramControl Properties

Provides a canvas where you or your end-users can display, create and edit various diagrams.
Name Description
AccessibilityObject Gets the AccessibleObject assigned to the control. Inherited from Control.
AccessibleDefaultActionDescription Gets or sets the default action description of the control for use by accessibility client applications. Inherited from Control.
AccessibleDescription Gets or sets the description of the control used by accessibility client applications. Inherited from Control.
AccessibleName Gets or sets the name of the control used by accessibility client applications. Inherited from Control.
AccessibleRole Gets or sets the accessible role of the control. Inherited from Control.
AllowHtmlTextInToolTip Gets or sets whether HTML formatting is allowed in the control’s regular tooltips. Inherited from BaseControl.
Anchor Gets or sets the edges of the container to which a control is bound and determines how a control is resized with its parent. Inherited from Control.
Appearance Provides access to the properties that control the appearance of the DiagramControl‘s elements.
AutoScrollOffset Gets or sets where this control is scrolled to in ScrollControlIntoView(Control). Inherited from Control.
AutoSize This property is not relevant for this class. Inherited from Control.
AutoSizeInLayoutControl

When a control is added to a LayoutControl, this property specifies whether the control’s width is changed to display its content in its entirety. This member is supported by individual descendant of the BaseControl class.

Inherited from BaseControl.
BackColor This property is not supported. Use the DiagramControl.Appearance property instead.
BackgroundImage Gets or sets the background image displayed in the control. Inherited from Control.
BackgroundImageLayout Gets or sets the background image layout as defined in the ImageLayout enumeration. Inherited from Control.
BindingContext Gets or sets the BindingContext for the control. Inherited from Control.
BorderStyle Gets or sets the control’s border style. Inherited from BaseControl.
Bottom Gets the distance, in pixels, between the bottom edge of the control and the top edge of its container’s client area. Inherited from Control.
Bounds Gets or sets the size and location of the control including its nonclient elements, in pixels, relative to the parent control. Inherited from Control.
CanEnableIme protected Gets a value indicating whether the ImeMode property can be set to an active value, to enable IME support. Inherited from Control.
CanFocus Gets a value indicating whether the control can receive focus. Inherited from Control.
CanRaiseEvents protected Determines if events can be raised on the control. Inherited from Control.
CanRedo Gets whether the Redo action can currently be performed.
CanSelect Gets a value indicating whether the control can be selected. Inherited from Control.
CanUndo Gets whether the Undo action can currently be performed.
CanvasScrollMode
CanvasSizeMode Obsolete. Gets or sets whether the canvas size is automatically expanded/shrunk to fit the current shapes layout.
Capture Gets or sets a value indicating whether the control has captured the mouse. Inherited from Control.
CausesValidation Gets or sets a value indicating whether the control causes validation to be performed on any controls that require validation when it receives focus. Inherited from Control.
CheckForIllegalCrossThreadCalls static Gets or sets a value indicating whether to catch calls on the wrong thread that access a control’s Handle property when an application is being debugged. Inherited from Control.
ClientRectangle Gets the rectangle that represents the client area of the control. Inherited from Control.
ClientSize Gets or sets the height and width of the client area of the control. Inherited from Control.
Commands Provides access to the set of available diagram commands.
CompanyName Gets the name of the company or creator of the application containing the control. Inherited from Control.
Container Gets the IContainer that contains the Component. Inherited from Component.
ContainsFocus Gets a value indicating whether the control, or one of its child controls, currently has the input focus. Inherited from Control.
ContextMenu Gets or sets the shortcut menu associated with the control. Inherited from Control.
ContextMenuStrip Gets or sets the ContextMenuStrip associated with this control. Inherited from Control.
Controls Gets the collection of controls contained within the control. Inherited from Control.
Created Gets a value indicating whether the control has been created. Inherited from Control.
Cursor This member is not supported.
DataBindings Gets the data bindings for the control. Inherited from Control.
DefaultBackColor static Gets the default background color of the control. Inherited from Control.
DefaultCursor protected Gets or sets the default cursor for the control. Inherited from Control.
DefaultFont static Gets the default font of the control. Inherited from Control.
DefaultForeColor static Gets the default foreground color of the control. Inherited from Control.
DefaultImeMode protected Gets the default Input Method Editor (IME) mode supported by the control. Inherited from Control.
DefaultMargin protected Gets the space, in pixels, that is specified by default between controls. Inherited from Control.
DefaultMaximumSize protected Gets the length and height, in pixels, that is specified as the default maximum size of a control. Inherited from Control.
DefaultMinimumSize protected Gets the length and height, in pixels, that is specified as the default minimum size of a control. Inherited from Control.
DefaultPadding protected Gets the internal spacing, in pixels, of the contents of a control. Inherited from Control.
DesignMode protected Gets a value that indicates whether the Component is currently in design mode. Inherited from Component.
DiagramViewInfo Returns the object which contains the internal information used to render the DiagramControl.
DisplayRectangle Gets the rectangle that represents the display area of the control. Inherited from Control.
Disposing Gets a value indicating whether the base Control class is in the process of disposing. Inherited from Control.
Dock Gets or sets which control borders are docked to its parent control and determines how a control is resized with its parent. Inherited from Control.
DocumentSource

Gets or sets the object from which a diagram is to be loaded or has been loaded. The current diagram is also saved to this object by certain Save actions. The DocumentSource can be a file full path, Uri object, stream and array of bytes.

DoubleBuffered protected Gets or sets a value indicating whether this control should redraw its surface using a secondary buffer to reduce or prevent flicker. Inherited from Control.
Enabled Gets or sets a value indicating whether the control can respond to user interaction. Inherited from Control.
Events protected Gets the list of event handlers that are attached to this Component. Inherited from Component.
FileDialogFilter This property is obsolete. Use the DiagramOptionsBehavior.FileDialogFilter property instead.
Focused Gets a value indicating whether the control has input focus. Inherited from Control.
Font This member is not supported. Use the DiagramControl.Appearance property instead.
FontHeight protected Gets or sets the height of the font of the control. Inherited from Control.
ForeColor This member is not supported. Use the DiagramControl.Appearance property instead.
Handle Gets the window handle that the control is bound to. Inherited from Control.
HasChanges Gets whether the current document has been changed using DiagramControl’s UI.
HasChildren Gets a value indicating whether the control contains one or more child controls. Inherited from Control.
Height Gets or sets the height of the control. Inherited from Control.
ImeMode Gets or sets the Input Method Editor (IME) mode of the control. Inherited from Control.
ImeModeBase protected Gets or sets the IME mode of a control. Inherited from Control.
InvokeRequired Gets a value indicating whether the caller must call an invoke method when making method calls to the control because the caller is on a different thread than the one the control was created on. Inherited from Control.
IsAccessible Gets or sets a value indicating whether the control is visible to accessibility applications. Inherited from Control.
IsContainerToolsVisible Gets whether the Container Tools Ribbon category is currently displayed.
IsDesignMode Gets a value indicating whether the control is currently in design mode. Inherited from BaseControl.
IsDisposed Gets a value indicating whether the control has been disposed of. Inherited from Control.
IsHandleCreated Gets a value indicating whether the control has a handle associated with it. Inherited from Control.
IsHScrollVisible Gets whether the horizontal scroll bar is visible.
IsImageToolsVisible Gets whether the Image Tools Ribbon category is currently displayed.
IsLoading Indicates whether the Diagram control is currently being initialized.
IsMirrored Gets a value indicating whether the control is mirrored. Inherited from Control.
IsRightToLeft Gets whether the ControlBase‘s visual elements are actually aligned to support locales using right-to-left fonts. Inherited from ControlBase.
IsTextEditMode Gets whether a diagram item’s text is currently being edited.
IsVScrollVisible Gets whether the vertical scroll bar is visible.
Items Provides access to the collection of diagram items displayed by the DiagramControl.
ItemTypeRegistrator static Provides access to methods used to create serializable custom diagram item types.
LastShapeStyles Provides access to the collection of the recently used shape styles.
LayoutEngine Gets a cached instance of the control’s layout engine. Inherited from Control.
Left Gets or sets the distance, in pixels, between the left edge of the control and the left edge of its container’s client area. Inherited from Control.
Location Gets or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container. Inherited from Control.
LookAndFeel Provides access to the object containing the control’s look and feel settings. Inherited from BaseControl.
Margin Gets or sets the space between controls. Inherited from Control.
MaximumSize Gets or sets the size that is the upper limit that GetPreferredSize(Size) can specify. Inherited from Control.
MenuManager Gets or sets the menu manager which controls the look and feel of the context menus.
MinimumSize Gets or sets the size that is the lower limit that GetPreferredSize(Size) can specify. Inherited from Control.
ModifierKeys static Gets a value indicating which of the modifier keys (SHIFT, CTRL, and ALT) is in a pressed state. Inherited from Control.
MouseButtons static Gets a value indicating which of the mouse buttons is in a pressed state. Inherited from Control.
MousePosition static Gets the position of the mouse cursor in screen coordinates. Inherited from Control.
Name Gets or sets the name of the control. Inherited from Control.
OptionsBehavior Contains options that control the DiagramControl’s behavior.
OptionsCircularLayout Contains options that control the circular layout.
OptionsConnector Contains options that control connectors.
OptionsExport Contains options that control diagram export.
OptionsMindMapTreeLayout Contains options that control the mind-map tree layout.
OptionsOrgChartLayout
OptionsProtection Contains options that control the ability of the end-user to perform certain operations.
OptionsSugiyamaLayout Contains options that control the Sugiyama (layered) layout.
OptionsTipOverTreeLayout Contains options that control the tip-over tree layout.
OptionsTreeLayout Contains options that control the tree layout.
OptionsView Contains the DiagramControl’s view settings.
Padding Gets or sets padding within the control. Inherited from Control.
Page Gets the diagram canvas.
PanAndZoom Gets or sets the Pan and Zoom Panel.
Parent Gets or sets the parent container of the control. Inherited from Control.
PlatformCache static This property supports the internal infrastructure and is not intended to be used directly from your code.
PreferredSize Gets the size of a rectangular area into which the control can fit. Inherited from Control.
PrimarySelection Gets the object that is currently the primary selected diagram item.
ProductName Gets the product name of the assembly containing the control. Inherited from Control.
ProductVersion Gets the version of the assembly containing the control. Inherited from Control.
PropagatingImeMode protected static Gets an object that represents a propagating IME mode. Inherited from Control.
PropertyGrid Gets or sets the Property Grid control that displays the properties of a diagram item, once it is selected on the diagram canvas, at runtime.
RecreatingHandle Gets a value indicating whether the control is currently re-creating its handle. Inherited from Control.
Region Gets or sets the window region associated with the control. Inherited from Control.
RenderRightToLeft protected This property is now obsolete. Inherited from Control.
ResizeRedraw protected Gets or sets a value indicating whether the control redraws itself when resized. Inherited from Control.
Right Gets the distance, in pixels, between the right edge of the control and the left edge of its container’s client area. Inherited from Control.
RightToLeft Gets or sets a value indicating whether control’s elements are aligned to support locales using right-to-left fonts. Inherited from Control.
RootToolsModel
ScaleChildren protected Gets a value that determines the scaling of child controls. Inherited from Control.
ScaleFactor Returns scale multipliers that are currently applied to a control’s original width and height. Inherited from BaseControl.
ScrollPos Gets or sets the current scrolling position.
SelectedItems Provides access to the collection of the currently selected diagram items.
SelectedStencils This property is obsolete. Use the DiagramOptionsBehavior.SelectedStencils property instead.
SelectionModel This member supports the internal infrastructure, and is not intended to be used directly from your code.
SelectionToolsModel This member supports the internal infrastructure, and is not intended to be used directly from your code.
ShowFocusCues protected Gets a value indicating whether the control should display focus rectangles. Inherited from Control.
ShowKeyboardCues protected Gets a value indicating whether the user interface is in the appropriate state to show or hide keyboard accelerators. Inherited from Control.
ShowToolTips Gets or sets whether a tooltip should be displayed when the mouse pointer is over the control. Inherited from BaseControl.
Site Gets or sets the site of the control. Inherited from Control.
Size Gets or sets the height and width of the control. Inherited from Control.
StyleController Gets or sets the style controller component that provides style settings for this control. Inherited from BaseControl.
SuperTip Gets or sets a SuperToolTip for the current control. Inherited from BaseControl.
TabIndex Gets or sets the tab order of the control within its container. Inherited from Control.
TabStop Gets or sets a value indicating whether the user can give the focus to this control using the TAB key. Inherited from Control.
Tag Gets or sets the object that contains data about the control. Inherited from Control.
Text Gets or sets the text associated with this control. Inherited from Control.
Title The document title to which the window title can be bound.
Toolbox Gets or sets a Toolbox Control linked to the DiagramControl and populated with diagram shapes.
ToolTip Gets or sets a regular tooltip’s text content. Inherited from BaseControl.
ToolTipAnchor This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from BaseControl.
ToolTipController Gets or sets the tooltip controller component that controls the appearance, position and content of hints displayed for this control. Inherited from BaseControl.
ToolTipIconType Gets or sets the type of the tooltip icon. Inherited from BaseControl.
ToolTipTitle Gets or sets a regular tooltip’s title. Inherited from BaseControl.
Top Gets or sets the distance, in pixels, between the top edge of the control and the top edge of its container’s client area. Inherited from Control.
TopLevelControl Gets the parent control that is not parented by another Windows Forms control. Typically, this is the outermost Form that the control is contained in. Inherited from Control.
UndoManager Provides access to an object that manages the undo and redo operations in the DiagramControl.
UseDirectXPaint Gets or sets whether to use the DirectX rendering.
UseWaitCursor Gets or sets a value indicating whether to use the wait cursor for the current control and all child controls. Inherited from Control.
Visible Gets or sets a value indicating whether the control and all its child controls are displayed. Inherited from Control.
Width Gets or sets the width of the control. Inherited from Control.
WindowTarget This property is not relevant for this class. Inherited from Control.
See Also