This topic has not yet been rated - Rate this topic

DocumentDesigner Class

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.

Namespace:  System.Windows.Forms.Design
Assembly:  System.Design (in System.Design.dll)
public class DocumentDesigner : ScrollableControlDesigner, 
	IRootDesigner, IDesigner, IDisposable, IToolboxUser

The DocumentDesigner type exposes the following members.

  Name Description
Public method DocumentDesigner Initializes a new instance of the DocumentDesigner class.
Top
  Name Description
Public property AccessibilityObject Gets the AccessibleObject assigned to the control. (Inherited from ControlDesigner.)
Public property ActionLists Gets the design-time action lists supported by the component associated with the designer. (Inherited from ComponentDesigner.)
Protected property AllowControlLasso Gets a value indicating whether selected controls will be re-parented. (Inherited from ParentControlDesigner.)
Protected property 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.)
Protected property AllowSetChildIndexOnDrop Gets a value indicating whether the z-order of dragged controls should be maintained when dropped on a ParentControlDesigner. (Inherited from ParentControlDesigner.)
Public property AssociatedComponents Gets the collection of components associated with the component managed by the designer. (Inherited from ControlDesigner.)
Public property AutoResizeHandles Infrastructure. Gets or sets a value indicating whether resize handle allocation depends on the value of the AutoSize property. (Inherited from ControlDesigner.)
Protected property BehaviorService Gets the BehaviorService from the design environment. (Inherited from ControlDesigner.)
Public property Component Gets the component this designer is designing. (Inherited from ComponentDesigner.)
Public property Control Gets the control that the designer is designing. (Inherited from ControlDesigner.)
Protected property DefaultControlLocation Gets the default location for a control added to the designer. (Inherited from ParentControlDesigner.)
Protected property DrawGrid Gets or sets a value indicating whether a grid should be drawn on the control for this designer. (Inherited from ParentControlDesigner.)
Protected property EnableDragRect Gets a value indicating whether drag rectangles are drawn by the designer. (Inherited from ParentControlDesigner.)
Protected property 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.)
Protected property InheritanceAttribute Gets the System.ComponentModel.InheritanceAttribute of the designer. (Inherited from ControlDesigner.)
Protected property Inherited Gets a value indicating whether this component is inherited. (Inherited from ComponentDesigner.)
Protected property MouseDragTool Gets a value indicating whether the designer has a valid tool during a drag operation. (Inherited from ParentControlDesigner.)
Protected property ParentComponent Gets the parent component for the ControlDesigner. (Inherited from ControlDesigner.)
Public property ParticipatesWithSnapLines Gets a value indicating whether the ControlDesigner will allow snapline alignment during a drag operation. (Inherited from ControlDesigner.)
Public property SelectionRules Gets the SelectionRules for the designer. (Overrides ControlDesigner.SelectionRules.)
Protected property ShadowProperties Gets a collection of property values that override user settings. (Inherited from ComponentDesigner.)
Public property SnapLines Gets a list of SnapLine objects representing significant alignment points for this control. (Inherited from ParentControlDesigner.)
Public property Verbs Gets the design-time verbs supported by the component that is associated with the designer. (Inherited from ComponentDesigner.)
Top
  Name Description
Protected method AddPaddingSnapLines Adds padding snaplines. (Inherited from ParentControlDesigner.)
Protected method BaseWndProc Processes Windows messages. (Inherited from ControlDesigner.)
Protected method CanAddComponent Infrastructure. Called when a component is added to the parent container. (Inherited from ParentControlDesigner.)
Public method CanBeParentedTo Indicates if this designer's control can be parented by the control of the specified designer. (Inherited from ControlDesigner.)
Public method CanParent(Control) Indicates whether the specified control can be a child of the control managed by this designer. (Inherited from ParentControlDesigner.)
Public method 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.)
Protected method CreateTool(ToolboxItem) Creates a component or control from the specified tool and adds it to the current design document. (Inherited from ParentControlDesigner.)
Protected method 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.)
Protected method 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.)
Protected method CreateToolCore Provides core functionality for all the CreateTool methods. (Inherited from ParentControlDesigner.)
Protected method DefWndProc Provides default processing for Windows messages. (Inherited from ControlDesigner.)
Protected method DisplayError Displays information about the specified exception to the user. (Inherited from ControlDesigner.)
Public method Dispose() Releases all resources used by the ComponentDesigner. (Inherited from ComponentDesigner.)
Protected method Dispose(Boolean) Releases the unmanaged resources used by the DocumentDesigner and optionally releases the managed resources. (Overrides ParentControlDesigner.Dispose(Boolean).)
Public method 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.)
Protected method EnableDesignMode Enables design time functionality for a child control. (Inherited from ControlDesigner.)
Protected method EnableDragDrop Enables or disables drag-and-drop support for the control being designed. (Inherited from ControlDesigner.)
Protected method EnsureMenuEditorService Checks for the existence of a menu editor service and creates one if one does not already exist.
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Attempts to free resources by calling Dispose(false) before the object is reclaimed by garbage collection. (Inherited from ComponentDesigner.)
Protected method GetControl Gets the control from the designer of the specified component. (Inherited from ParentControlDesigner.)
Protected method GetControlGlyph Gets a body glyph that represents the bounds of the control. (Inherited from ParentControlDesigner.)
Public method GetGlyphs Gets a GlyphCollection representing the Glyph objects. (Overrides ParentControlDesigner.GetGlyphs(GlyphSelectionType).)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Protected method GetHitTest Indicates whether a mouse click at the specified point should be handled by the control. (Inherited from ScrollableControlDesigner.)
Protected method GetParentForComponent 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.)
Protected method GetService Attempts to retrieve the specified type of service from the design mode site of the designer's component. (Inherited from ComponentDesigner.)
Protected method GetToolSupported Indicates whether the specified tool is supported by the designer.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method GetUpdatedRect Updates the position of the specified rectangle, adjusting it for grid alignment if grid alignment mode is enabled. (Inherited from ParentControlDesigner.)
Protected method HookChildControls Routes messages from the child controls of the specified control to the designer. (Inherited from ControlDesigner.)
Public method Initialize Initializes the designer with the specified component. (Overrides ParentControlDesigner.Initialize(IComponent).)
Public method InitializeExistingComponent Re-initializes an existing component. (Inherited from ControlDesigner.)
Public method InitializeNewComponent Initializes a newly created component. (Inherited from ParentControlDesigner.)
Public method InitializeNonDefault Obsolete. Initializes the settings for an imported component that is already initialized to settings other than the defaults. (Inherited from ComponentDesigner.)
Public method InternalControlDesigner Returns the internal control designer with the specified index in the ControlDesigner. (Inherited from ControlDesigner.)
Protected method InvokeGetInheritanceAttribute Gets the InheritanceAttribute of the specified ComponentDesigner. (Inherited from ComponentDesigner.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method NumberOfInternalControlDesigners Returns the number of internal control designers in the ControlDesigner. (Inherited from ControlDesigner.)
Protected method OnContextMenu Called when the context menu should be displayed. (Overrides ControlDesigner.OnContextMenu(Int32, Int32).)
Protected method OnCreateHandle Called immediately after the handle for the designer has been created. (Overrides ControlDesigner.OnCreateHandle().)
Protected method OnDragComplete Called in order to clean up a drag-and-drop operation. (Inherited from ParentControlDesigner.)
Protected method OnDragDrop Called when a drag-and-drop object is dropped onto the control designer view. (Inherited from ParentControlDesigner.)
Protected method OnDragEnter Called when a drag-and-drop operation enters the control designer view. (Inherited from ParentControlDesigner.)
Protected method OnDragLeave Called when a drag-and-drop operation leaves the control designer view. (Inherited from ParentControlDesigner.)
Protected method OnDragOver Called when a drag-and-drop object is dragged over the control designer view. (Inherited from ParentControlDesigner.)
Protected method OnGiveFeedback Receives a call 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 ControlDesigner.)
Protected method OnMouseDragBegin Called in response to the left mouse button being pressed and held while over the component. (Inherited from ParentControlDesigner.)
Protected method OnMouseDragEnd Called at the end of a drag-and-drop operation to complete or cancel the operation. (Inherited from ParentControlDesigner.)
Protected method OnMouseDragMove Called for each movement of the mouse during a drag-and-drop operation. (Inherited from ParentControlDesigner.)
Protected method OnMouseEnter Receives a call when the mouse first enters the control. (Inherited from ControlDesigner.)
Protected method OnMouseHover Receives a call after the mouse hovers over the control. (Inherited from ControlDesigner.)
Protected method OnMouseLeave Receives a call when the mouse first enters the control. (Inherited from ControlDesigner.)
Protected method OnPaintAdornments 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.)
Public method OnSetComponentDefaults Obsolete. Called when the designer is intialized. (Inherited from ControlDesigner.)
Protected method OnSetCursor Provides an opportunity to change the current mouse cursor. (Inherited from ParentControlDesigner.)
Protected method PostFilterAttributes Allows a designer to change or remove items from the set of attributes that it exposes through a TypeDescriptor. (Inherited from ComponentDesigner.)
Protected method PostFilterEvents Allows a designer to change or remove items from the set of events that it exposes through a TypeDescriptor. (Inherited from ComponentDesigner.)
Protected method PostFilterProperties Allows a designer to change or remove items from the set of properties that it exposes through a TypeDescriptor. (Inherited from ComponentDesigner.)
Protected method PreFilterAttributes Allows a designer to add to the set of attributes that it exposes through a TypeDescriptor. (Inherited from ComponentDesigner.)
Protected method PreFilterEvents Allows a designer to add to the set of events that it exposes through a TypeDescriptor. (Inherited from ComponentDesigner.)
Protected method PreFilterProperties Adjusts the set of properties the component exposes through a TypeDescriptor. (Overrides ParentControlDesigner.PreFilterProperties(IDictionary).)
Protected method RaiseComponentChanged Notifies the IComponentChangeService that this component has been changed. (Inherited from ComponentDesigner.)
Protected method RaiseComponentChanging Notifies the IComponentChangeService that this component is about to be changed. (Inherited from ComponentDesigner.)
Protected method ToolPicked Selects the specified tool.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Protected method UnhookChildControls Routes messages for the children of the specified control to each control rather than to a parent designer. (Inherited from ControlDesigner.)
Protected method WndProc Processes Windows messages. (Overrides ScrollableControlDesigner.WndProc(Message).)
Top
  Name Description
Protected field accessibilityObj Specifies the accessibility object for the designer. (Inherited from ControlDesigner.)
Protected field menuEditorService Initializes the menuEditorService variable to null.
Top
  Name Description
Explicit interface implemetation Private method IDesignerFilter.PostFilterAttributes For a description of this member, see the IDesignerFilter.PostFilterAttributes method. (Inherited from ComponentDesigner.)
Explicit interface implemetation Private method IDesignerFilter.PostFilterEvents For a description of this member, see the IDesignerFilter.PostFilterEvents method. (Inherited from ComponentDesigner.)
Explicit interface implemetation Private method IDesignerFilter.PostFilterProperties For a description of this member, see the IDesignerFilter.PostFilterProperties method. (Inherited from ComponentDesigner.)
Explicit interface implemetation Private method IDesignerFilter.PreFilterAttributes For a description of this member, see the IDesignerFilter.PreFilterAttributes method. (Inherited from ComponentDesigner.)
Explicit interface implemetation Private method IDesignerFilter.PreFilterEvents For a description of this member, see the IDesignerFilter.PreFilterEvents method. (Inherited from ComponentDesigner.)
Explicit interface implemetation Private method IDesignerFilter.PreFilterProperties For a description of this member, see the IDesignerFilter.PreFilterProperties method. (Inherited from ComponentDesigner.)
Explicit interface implemetation Private method IRootDesigner.GetView For a description of this member, see System.ComponentModel.Design.ViewTechnology.
Explicit interface implemetation Private property IRootDesigner.SupportedTechnologies For a description of this member, see IRootDesigner.SupportedTechnologies.
Explicit interface implemetation Private method IToolboxUser.GetToolSupported For a description of this member, see IToolboxUser.GetToolSupported.
Explicit interface implemetation Private method IToolboxUser.ToolPicked For a description of this member, see IToolboxUser.ToolPicked.
Explicit interface implemetation Private property ITreeDesigner.Children For a description of this member, see the ITreeDesigner.Children property. (Inherited from ComponentDesigner.)
Explicit interface implemetation Private property ITreeDesigner.Parent For a description of this member, see the ITreeDesigner.Parent property. (Inherited from ComponentDesigner.)
Top

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.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ