DocumentDesigner DocumentDesigner DocumentDesigner DocumentDesigner Class

Definition

Base designer class for extending the design mode behavior of, and providing a root-level design mode view for, a Control that supports nested controls and should receive scroll messages.

public ref class DocumentDesigner : System::Windows::Forms::Design::ScrollableControlDesigner, IDisposable, System::ComponentModel::Design::IRootDesigner, System::Drawing::Design::IToolboxUser
public class DocumentDesigner : System.Windows.Forms.Design.ScrollableControlDesigner, IDisposable, System.ComponentModel.Design.IRootDesigner, System.Drawing.Design.IToolboxUser
type DocumentDesigner = class
    inherit ScrollableControlDesigner
    interface IRootDesigner
    interface IDesigner
    interface IDisposable
    interface IToolboxUser
Public Class DocumentDesigner
Inherits ScrollableControlDesigner
Implements IDisposable, IRootDesigner, IToolboxUser
Inheritance
Implements

Remarks

This designer is a root designer, meaning that it provides the root-level design mode view for the associated document when it is viewed in design mode.

You can associate a designer with a type using a DesignerAttribute. For an overview of customizing design time behavior, see Extending Design-Time Support.

Constructors

DocumentDesigner() DocumentDesigner() DocumentDesigner() DocumentDesigner()

Initializes a new instance of the DocumentDesigner class.

Fields

accessibilityObj accessibilityObj accessibilityObj accessibilityObj

Specifies the accessibility object for the designer.

(Inherited from ControlDesigner)
menuEditorService menuEditorService menuEditorService menuEditorService

Initializes the menuEditorService variable to null.

Properties

AccessibilityObject AccessibilityObject AccessibilityObject AccessibilityObject

Gets the AccessibleObject assigned to the control.

(Inherited from ControlDesigner)
ActionLists ActionLists ActionLists ActionLists

Gets the design-time action lists supported by the component associated with the designer.

(Inherited from ComponentDesigner)
AllowControlLasso AllowControlLasso AllowControlLasso AllowControlLasso

Gets a value indicating whether selected controls will be re-parented.

(Inherited from ParentControlDesigner)
AllowGenericDragBox AllowGenericDragBox AllowGenericDragBox AllowGenericDragBox

Gets a value indicating whether a generic drag box should be drawn when dragging a toolbox item over the designer's surface.

(Inherited from ParentControlDesigner)
AllowSetChildIndexOnDrop AllowSetChildIndexOnDrop AllowSetChildIndexOnDrop AllowSetChildIndexOnDrop

Gets a value indicating whether the z-order of dragged controls should be maintained when dropped on a ParentControlDesigner.

(Inherited from ParentControlDesigner)
AssociatedComponents AssociatedComponents AssociatedComponents AssociatedComponents

Gets the collection of components associated with the component managed by the designer.

(Inherited from ControlDesigner)
AutoResizeHandles AutoResizeHandles AutoResizeHandles AutoResizeHandles

Gets or sets a value indicating whether resize handle allocation depends on the value of the AutoSize property.

(Inherited from ControlDesigner)
BehaviorService BehaviorService BehaviorService BehaviorService

Gets the BehaviorService from the design environment.

(Inherited from ControlDesigner)
Component Component Component Component

Gets the component this designer is designing.

(Inherited from ComponentDesigner)
Control Control Control Control

Gets the control that the designer is designing.

(Inherited from ControlDesigner)
DefaultControlLocation DefaultControlLocation DefaultControlLocation DefaultControlLocation

Gets the default location for a control added to the designer.

(Inherited from ParentControlDesigner)
DrawGrid DrawGrid DrawGrid DrawGrid

Gets or sets a value indicating whether a grid should be drawn on the control for this designer.

(Inherited from ParentControlDesigner)
EnableDragRect EnableDragRect EnableDragRect EnableDragRect

Gets a value indicating whether drag rectangles are drawn by the designer.

(Inherited from ParentControlDesigner)
GridSize GridSize GridSize GridSize

Gets or sets the size of each square of the grid that is drawn when the designer is in grid draw mode.

(Inherited from ParentControlDesigner)
InheritanceAttribute InheritanceAttribute InheritanceAttribute InheritanceAttribute

Gets the InheritanceAttribute of the designer.

(Inherited from ControlDesigner)
Inherited Inherited Inherited Inherited

Gets a value indicating whether this component is inherited.

(Inherited from ComponentDesigner)
ITreeDesigner.Children ITreeDesigner.Children ITreeDesigner.Children ITreeDesigner.Children

For a description of this member, see the Children property.

(Inherited from ComponentDesigner)
ITreeDesigner.Parent ITreeDesigner.Parent ITreeDesigner.Parent ITreeDesigner.Parent

For a description of this member, see the Parent property.

(Inherited from ComponentDesigner)
MouseDragTool MouseDragTool MouseDragTool MouseDragTool

Gets a value indicating whether the designer has a valid tool during a drag operation.

(Inherited from ParentControlDesigner)
ParentComponent ParentComponent ParentComponent ParentComponent

Gets the parent component for the ControlDesigner.

(Inherited from ControlDesigner)
ParticipatesWithSnapLines ParticipatesWithSnapLines ParticipatesWithSnapLines ParticipatesWithSnapLines

Gets a value indicating whether the ControlDesigner will allow snapline alignment during a drag operation.

(Inherited from ControlDesigner)
SelectionRules SelectionRules SelectionRules SelectionRules

Gets the SelectionRules for the designer.

ShadowProperties ShadowProperties ShadowProperties ShadowProperties

Gets a collection of property values that override user settings.

(Inherited from ComponentDesigner)
SnapLines SnapLines SnapLines SnapLines

Gets a list of SnapLine objects representing significant alignment points for this control.

(Inherited from ParentControlDesigner)
Verbs Verbs Verbs Verbs

Gets the design-time verbs supported by the component that is associated with the designer.

(Inherited from ComponentDesigner)

Methods

AddPaddingSnapLines(ArrayList) AddPaddingSnapLines(ArrayList) AddPaddingSnapLines(ArrayList) AddPaddingSnapLines(ArrayList)

Adds padding snaplines.

(Inherited from ParentControlDesigner)
BaseWndProc(Message) BaseWndProc(Message) BaseWndProc(Message) BaseWndProc(Message)

Processes Windows messages.

(Inherited from ControlDesigner)
CanAddComponent(IComponent) CanAddComponent(IComponent) CanAddComponent(IComponent) CanAddComponent(IComponent)

Called when a component is added to the parent container.

(Inherited from ParentControlDesigner)
CanBeParentedTo(IDesigner) CanBeParentedTo(IDesigner) CanBeParentedTo(IDesigner) CanBeParentedTo(IDesigner)

Indicates if this designer's control can be parented by the control of the specified designer.

(Inherited from ControlDesigner)
CanParent(Control) CanParent(Control) CanParent(Control) CanParent(Control)

Indicates whether the specified control can be a child of the control managed by this designer.

(Inherited from ParentControlDesigner)
CanParent(ControlDesigner) CanParent(ControlDesigner) CanParent(ControlDesigner) CanParent(ControlDesigner)

Indicates whether the control managed by the specified designer can be a child of the control managed by this designer.

(Inherited from ParentControlDesigner)
CreateTool(ToolboxItem) CreateTool(ToolboxItem) CreateTool(ToolboxItem) CreateTool(ToolboxItem)

Creates a component or control from the specified tool and adds it to the current design document.

(Inherited from ParentControlDesigner)
CreateTool(ToolboxItem, Point) CreateTool(ToolboxItem, Point) CreateTool(ToolboxItem, Point) CreateTool(ToolboxItem, Point)

Creates a component or control from the specified tool and adds it to the current design document at the specified location.

(Inherited from ParentControlDesigner)
CreateTool(ToolboxItem, Rectangle) CreateTool(ToolboxItem, Rectangle) CreateTool(ToolboxItem, Rectangle) CreateTool(ToolboxItem, Rectangle)

Creates a component or control from the specified tool and adds it to the current design document within the bounds of the specified rectangle.

(Inherited from ParentControlDesigner)
CreateToolCore(ToolboxItem, Int32, Int32, Int32, Int32, Boolean, Boolean) CreateToolCore(ToolboxItem, Int32, Int32, Int32, Int32, Boolean, Boolean) CreateToolCore(ToolboxItem, Int32, Int32, Int32, Int32, Boolean, Boolean) CreateToolCore(ToolboxItem, Int32, Int32, Int32, Int32, Boolean, Boolean)

Provides core functionality for all the CreateTool(ToolboxItem) methods.

(Inherited from ParentControlDesigner)
DefWndProc(Message) DefWndProc(Message) DefWndProc(Message) DefWndProc(Message)

Provides default processing for Windows messages.

(Inherited from ControlDesigner)
DisplayError(Exception) DisplayError(Exception) DisplayError(Exception) DisplayError(Exception)

Displays information about the specified exception to the user.

(Inherited from ControlDesigner)
Dispose() Dispose() Dispose() Dispose()

Releases all resources used by the ComponentDesigner.

(Inherited from ComponentDesigner)
Dispose(Boolean) Dispose(Boolean) Dispose(Boolean) Dispose(Boolean)

Releases the unmanaged resources used by the DocumentDesigner and optionally releases the managed resources.

DoDefaultAction() DoDefaultAction() DoDefaultAction() DoDefaultAction()

Creates a method signature in the source code file for the default event on the component and navigates the user's cursor to that location.

(Inherited from ComponentDesigner)
EnableDesignMode(Control, String) EnableDesignMode(Control, String) EnableDesignMode(Control, String) EnableDesignMode(Control, String)

Enables design time functionality for a child control.

(Inherited from ControlDesigner)
EnableDragDrop(Boolean) EnableDragDrop(Boolean) EnableDragDrop(Boolean) EnableDragDrop(Boolean)

Enables or disables drag-and-drop support for the control being designed.

(Inherited from ControlDesigner)
EnsureMenuEditorService(IComponent) EnsureMenuEditorService(IComponent) EnsureMenuEditorService(IComponent) EnsureMenuEditorService(IComponent)

Checks for the existence of a menu editor service and creates one if one does not already exist.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetControl(Object) GetControl(Object) GetControl(Object) GetControl(Object)

Gets the control from the designer of the specified component.

(Inherited from ParentControlDesigner)
GetControlGlyph(GlyphSelectionType) GetControlGlyph(GlyphSelectionType) GetControlGlyph(GlyphSelectionType) GetControlGlyph(GlyphSelectionType)

Gets a body glyph that represents the bounds of the control.

(Inherited from ParentControlDesigner)
GetGlyphs(GlyphSelectionType) GetGlyphs(GlyphSelectionType) GetGlyphs(GlyphSelectionType) GetGlyphs(GlyphSelectionType)

Gets a GlyphCollection representing the Glyph objects.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetHitTest(Point) GetHitTest(Point) GetHitTest(Point) GetHitTest(Point)

Indicates whether a mouse click at the specified point should be handled by the control.

(Inherited from ScrollableControlDesigner)
GetParentForComponent(IComponent) GetParentForComponent(IComponent) GetParentForComponent(IComponent) GetParentForComponent(IComponent)

Used by deriving classes to determine if it returns the control being designed or some other Container while adding a component to it.

(Inherited from ParentControlDesigner)
GetService(Type) GetService(Type) GetService(Type) GetService(Type)

Attempts to retrieve the specified type of service from the design mode site of the designer's component.

(Inherited from ComponentDesigner)
GetToolSupported(ToolboxItem) GetToolSupported(ToolboxItem) GetToolSupported(ToolboxItem) GetToolSupported(ToolboxItem)

Indicates whether the specified tool is supported by the designer.

GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
GetUpdatedRect(Rectangle, Rectangle, Boolean) GetUpdatedRect(Rectangle, Rectangle, Boolean) GetUpdatedRect(Rectangle, Rectangle, Boolean) GetUpdatedRect(Rectangle, Rectangle, Boolean)

Updates the position of the specified rectangle, adjusting it for grid alignment if grid alignment mode is enabled.

(Inherited from ParentControlDesigner)
HookChildControls(Control) HookChildControls(Control) HookChildControls(Control) HookChildControls(Control)

Routes messages from the child controls of the specified control to the designer.

(Inherited from ControlDesigner)
Initialize(IComponent) Initialize(IComponent) Initialize(IComponent) Initialize(IComponent)

Initializes the designer with the specified component.

InitializeExistingComponent(IDictionary) InitializeExistingComponent(IDictionary) InitializeExistingComponent(IDictionary) InitializeExistingComponent(IDictionary)

Re-initializes an existing component.

(Inherited from ControlDesigner)
InitializeNewComponent(IDictionary) InitializeNewComponent(IDictionary) InitializeNewComponent(IDictionary) InitializeNewComponent(IDictionary)

Initializes a newly created component.

(Inherited from ParentControlDesigner)
InitializeNonDefault() InitializeNonDefault() InitializeNonDefault() InitializeNonDefault()

Initializes properties of the control to any non-default values.

(Inherited from ControlDesigner)
InternalControlDesigner(Int32) InternalControlDesigner(Int32) InternalControlDesigner(Int32) InternalControlDesigner(Int32)

Returns the internal control designer with the specified index in the ControlDesigner.

(Inherited from ControlDesigner)
InvokeGetInheritanceAttribute(ComponentDesigner) InvokeGetInheritanceAttribute(ComponentDesigner) InvokeGetInheritanceAttribute(ComponentDesigner) InvokeGetInheritanceAttribute(ComponentDesigner)

Gets the InheritanceAttribute of the specified ComponentDesigner.

(Inherited from ComponentDesigner)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
NumberOfInternalControlDesigners() NumberOfInternalControlDesigners() NumberOfInternalControlDesigners() NumberOfInternalControlDesigners()

Returns the number of internal control designers in the ControlDesigner.

(Inherited from ControlDesigner)
OnContextMenu(Int32, Int32) OnContextMenu(Int32, Int32) OnContextMenu(Int32, Int32) OnContextMenu(Int32, Int32)

Called when the context menu should be displayed.

OnCreateHandle() OnCreateHandle() OnCreateHandle() OnCreateHandle()

Called immediately after the handle for the designer has been created.

OnDragComplete(DragEventArgs) OnDragComplete(DragEventArgs) OnDragComplete(DragEventArgs) OnDragComplete(DragEventArgs)

Called in order to clean up a drag-and-drop operation.

(Inherited from ParentControlDesigner)
OnDragDrop(DragEventArgs) OnDragDrop(DragEventArgs) OnDragDrop(DragEventArgs) OnDragDrop(DragEventArgs)

Called when a drag-and-drop object is dropped onto the control designer view.

(Inherited from ParentControlDesigner)
OnDragEnter(DragEventArgs) OnDragEnter(DragEventArgs) OnDragEnter(DragEventArgs) OnDragEnter(DragEventArgs)

Called when a drag-and-drop operation enters the control designer view.

(Inherited from ParentControlDesigner)
OnDragLeave(EventArgs) OnDragLeave(EventArgs) OnDragLeave(EventArgs) OnDragLeave(EventArgs)

Called when a drag-and-drop operation leaves the control designer view.

(Inherited from ParentControlDesigner)
OnDragOver(DragEventArgs) OnDragOver(DragEventArgs) OnDragOver(DragEventArgs) OnDragOver(DragEventArgs)

Called when a drag-and-drop object is dragged over the control designer view.

(Inherited from ParentControlDesigner)
OnGiveFeedback(GiveFeedbackEventArgs) OnGiveFeedback(GiveFeedbackEventArgs) OnGiveFeedback(GiveFeedbackEventArgs) OnGiveFeedback(GiveFeedbackEventArgs)

Called when a drag-and-drop operation is in progress to provide visual cues based on the location of the mouse while a drag operation is in progress.

(Inherited from ParentControlDesigner)
OnMouseDragBegin(Int32, Int32) OnMouseDragBegin(Int32, Int32) OnMouseDragBegin(Int32, Int32) OnMouseDragBegin(Int32, Int32)

Called in response to the left mouse button being pressed and held while over the component.

(Inherited from ParentControlDesigner)
OnMouseDragEnd(Boolean) OnMouseDragEnd(Boolean) OnMouseDragEnd(Boolean) OnMouseDragEnd(Boolean)

Called at the end of a drag-and-drop operation to complete or cancel the operation.

(Inherited from ParentControlDesigner)
OnMouseDragMove(Int32, Int32) OnMouseDragMove(Int32, Int32) OnMouseDragMove(Int32, Int32) OnMouseDragMove(Int32, Int32)

Called for each movement of the mouse during a drag-and-drop operation.

(Inherited from ParentControlDesigner)
OnMouseEnter() OnMouseEnter() OnMouseEnter() OnMouseEnter()

Called when the mouse first enters the control.

(Inherited from ParentControlDesigner)
OnMouseHover() OnMouseHover() OnMouseHover() OnMouseHover()

Called after the mouse hovers over the control.

(Inherited from ParentControlDesigner)
OnMouseLeave() OnMouseLeave() OnMouseLeave() OnMouseLeave()

Called when the mouse first enters the control.

(Inherited from ParentControlDesigner)
OnPaintAdornments(PaintEventArgs) OnPaintAdornments(PaintEventArgs) OnPaintAdornments(PaintEventArgs) OnPaintAdornments(PaintEventArgs)

Called when the control that the designer is managing has painted its surface so the designer can paint any additional adornments on top of the control.

(Inherited from ParentControlDesigner)
OnSetComponentDefaults() OnSetComponentDefaults() OnSetComponentDefaults() OnSetComponentDefaults()

Called when the designer is initialized.

(Inherited from ControlDesigner)
OnSetCursor() OnSetCursor() OnSetCursor() OnSetCursor()

Provides an opportunity to change the current mouse cursor.

(Inherited from ParentControlDesigner)
PostFilterAttributes(IDictionary) PostFilterAttributes(IDictionary) PostFilterAttributes(IDictionary) PostFilterAttributes(IDictionary)

Allows a designer to change or remove items from the set of attributes that it exposes through a TypeDescriptor.

(Inherited from ComponentDesigner)
PostFilterEvents(IDictionary) PostFilterEvents(IDictionary) PostFilterEvents(IDictionary) PostFilterEvents(IDictionary)

Allows a designer to change or remove items from the set of events that it exposes through a TypeDescriptor.

(Inherited from ComponentDesigner)
PostFilterProperties(IDictionary) PostFilterProperties(IDictionary) PostFilterProperties(IDictionary) PostFilterProperties(IDictionary)

Allows a designer to change or remove items from the set of properties that it exposes through a TypeDescriptor.

(Inherited from ComponentDesigner)
PreFilterAttributes(IDictionary) PreFilterAttributes(IDictionary) PreFilterAttributes(IDictionary) PreFilterAttributes(IDictionary)

Allows a designer to add to the set of attributes that it exposes through a TypeDescriptor.

(Inherited from ComponentDesigner)
PreFilterEvents(IDictionary) PreFilterEvents(IDictionary) PreFilterEvents(IDictionary) PreFilterEvents(IDictionary)

Allows a designer to add to the set of events that it exposes through a TypeDescriptor.

(Inherited from ComponentDesigner)
PreFilterProperties(IDictionary) PreFilterProperties(IDictionary) PreFilterProperties(IDictionary) PreFilterProperties(IDictionary)

Adjusts the set of properties the component exposes through a TypeDescriptor.

RaiseComponentChanged(MemberDescriptor, Object, Object) RaiseComponentChanged(MemberDescriptor, Object, Object) RaiseComponentChanged(MemberDescriptor, Object, Object) RaiseComponentChanged(MemberDescriptor, Object, Object)

Notifies the IComponentChangeService that this component has been changed.

(Inherited from ComponentDesigner)
RaiseComponentChanging(MemberDescriptor) RaiseComponentChanging(MemberDescriptor) RaiseComponentChanging(MemberDescriptor) RaiseComponentChanging(MemberDescriptor)

Notifies the IComponentChangeService that this component is about to be changed.

(Inherited from ComponentDesigner)
ToolPicked(ToolboxItem) ToolPicked(ToolboxItem) ToolPicked(ToolboxItem) ToolPicked(ToolboxItem)

Selects the specified tool.

ToString() ToString() ToString() ToString()

Returns a string that represents the current object.

(Inherited from Object)
UnhookChildControls(Control) UnhookChildControls(Control) UnhookChildControls(Control) UnhookChildControls(Control)

Routes messages for the children of the specified control to each control rather than to a parent designer.

(Inherited from ControlDesigner)
WndProc(Message) WndProc(Message) WndProc(Message) WndProc(Message)

Processes Windows messages.

Explicit Interface Implementations

IDesignerFilter.PostFilterAttributes(IDictionary) IDesignerFilter.PostFilterAttributes(IDictionary) IDesignerFilter.PostFilterAttributes(IDictionary) IDesignerFilter.PostFilterAttributes(IDictionary)

For a description of this member, see the PostFilterAttributes(IDictionary) method.

(Inherited from ComponentDesigner)
IDesignerFilter.PostFilterEvents(IDictionary) IDesignerFilter.PostFilterEvents(IDictionary) IDesignerFilter.PostFilterEvents(IDictionary) IDesignerFilter.PostFilterEvents(IDictionary)

For a description of this member, see the PostFilterEvents(IDictionary) method.

(Inherited from ComponentDesigner)
IDesignerFilter.PostFilterProperties(IDictionary) IDesignerFilter.PostFilterProperties(IDictionary) IDesignerFilter.PostFilterProperties(IDictionary) IDesignerFilter.PostFilterProperties(IDictionary)

For a description of this member, see the PostFilterProperties(IDictionary) method.

(Inherited from ComponentDesigner)
IDesignerFilter.PreFilterAttributes(IDictionary) IDesignerFilter.PreFilterAttributes(IDictionary) IDesignerFilter.PreFilterAttributes(IDictionary) IDesignerFilter.PreFilterAttributes(IDictionary)

For a description of this member, see the PreFilterAttributes(IDictionary) method.

(Inherited from ComponentDesigner)
IDesignerFilter.PreFilterEvents(IDictionary) IDesignerFilter.PreFilterEvents(IDictionary) IDesignerFilter.PreFilterEvents(IDictionary) IDesignerFilter.PreFilterEvents(IDictionary)

For a description of this member, see the PreFilterEvents(IDictionary) method.

(Inherited from ComponentDesigner)
IDesignerFilter.PreFilterProperties(IDictionary) IDesignerFilter.PreFilterProperties(IDictionary) IDesignerFilter.PreFilterProperties(IDictionary) IDesignerFilter.PreFilterProperties(IDictionary)

For a description of this member, see the PreFilterProperties(IDictionary) method.

(Inherited from ComponentDesigner)
IRootDesigner.GetView(ViewTechnology) IRootDesigner.GetView(ViewTechnology) IRootDesigner.GetView(ViewTechnology) IRootDesigner.GetView(ViewTechnology)

For a description of this member, see ViewTechnology.

IRootDesigner.SupportedTechnologies IRootDesigner.SupportedTechnologies IRootDesigner.SupportedTechnologies IRootDesigner.SupportedTechnologies

For a description of this member, see SupportedTechnologies.

IToolboxUser.GetToolSupported(ToolboxItem) IToolboxUser.GetToolSupported(ToolboxItem) IToolboxUser.GetToolSupported(ToolboxItem) IToolboxUser.GetToolSupported(ToolboxItem)

For a description of this member, see GetToolSupported(ToolboxItem).

IToolboxUser.ToolPicked(ToolboxItem) IToolboxUser.ToolPicked(ToolboxItem) IToolboxUser.ToolPicked(ToolboxItem) IToolboxUser.ToolPicked(ToolboxItem)

For a description of this member, see ToolPicked(ToolboxItem).

Applies to

See also