SiteMapDataSourceDesigner Class

.NET Framework (current version)

Provides design-time support in a visual designer for the SiteMapDataSourceDesigner control.

Namespace: System.Web.UI.Design.WebControls
Assembly: System.Design (in System.Design.dll)

Inheritance Hierarchy

System::Object
System.ComponentModel.Design::ComponentDesigner
System.Web.UI.Design::HtmlControlDesigner
System.Web.UI.Design::ControlDesigner
System.Web.UI.Design::HierarchicalDataSourceDesigner
System.Web.UI.Design.WebControls::SiteMapDataSourceDesigner

Syntax

C++

[SecurityPermissionAttribute(SecurityAction::Demand, Flags = SecurityPermissionFlag::UnmanagedCode)]
public ref class SiteMapDataSourceDesigner : HierarchicalDataSourceDesigner, 
	IDataSourceDesigner

Constructors

	Name	Description
	SiteMapDataSourceDesigner()	Creates an instance of the SiteMapDataSourceDesigner class.

Properties

	Name	Description
	ActionLists	Gets the action list collection for the control designer.(Inherited from HierarchicalDataSourceDesigner.)
	AllowResize	Gets a value indicating whether the control can be resized in the design-time environment.(Inherited from ControlDesigner.)
	AssociatedComponents	Gets the collection of components associated with the component managed by the designer.(Inherited from ComponentDesigner.)
	AutoFormats	Gets the collection of predefined automatic formatting schemes to display in the Auto Format dialog box for the associated control at design time. (Inherited from ControlDesigner.)
	Behavior	Obsolete. Gets or sets the DHTML behavior that is associated with the designer.(Inherited from HtmlControlDesigner.)
	CanConfigure	Gets a value that indicates whether the Configure method can be called.(Inherited from HierarchicalDataSourceDesigner.)
	CanRefreshSchema	Gets a value indicating whether the schema can be refreshed.(Overrides HierarchicalDataSourceDesigner::CanRefreshSchema.)
	Component	Gets the component this designer is designing.(Inherited from ComponentDesigner.)
	DataBindings	Gets the data bindings collection for the current control.(Inherited from HtmlControlDesigner.)
	DataBindingsEnabled	Gets a value indicating whether data binding is supported by the containing region for the associated control.(Inherited from ControlDesigner.)
	DesignerState	Gets an object that is used to persist data for the associated control at design time.(Inherited from ControlDesigner.)
	DesignTimeElement	Obsolete. Gets the design-time object representing the control that is associated with the HtmlControlDesigner object on the design surface.(Inherited from HtmlControlDesigner.)
	DesignTimeElementView	Obsolete. Gets the view-control object for the control designer.(Inherited from ControlDesigner.)
	DesignTimeHtmlRequiresLoadComplete	Obsolete. Gets a value indicating whether the design host must finish loading before the GetDesignTimeHtml method can be called.(Inherited from ControlDesigner.)
	Expressions	Gets the expression bindings for the current control at design time.(Inherited from HtmlControlDesigner.)
	HidePropertiesInTemplateMode	This API supports the product infrastructure and is not intended to be used directly from your code. Gets a value indicating whether the properties of the associated control are hidden when the control is in template mode.(Inherited from ControlDesigner.)
	ID	Gets or sets the ID string for the control.(Inherited from ControlDesigner.)
	InheritanceAttribute	Gets an attribute that indicates the type of inheritance of the associated component.(Inherited from ComponentDesigner.)
	Inherited	Gets a value indicating whether this component is inherited.(Inherited from ComponentDesigner.)
	InTemplateMode	Gets a value indicating whether the control is in either template viewing or editing mode in the design host. The InTemplateMode property is read-only.(Inherited from ControlDesigner.)
	IsDirty	Obsolete. Gets or sets a value indicating whether the Web server control has been marked as changed.(Inherited from ControlDesigner.)
	ParentComponent	Gets the parent component for this designer.(Inherited from ComponentDesigner.)
	ReadOnly	Obsolete. Gets or sets a value indicating whether the properties of the control are read-only at design time.(Inherited from ControlDesigner.)
	RootDesigner	Gets the control designer for the Web Forms page that contains the associated control.(Inherited from ControlDesigner.)
	ShadowProperties	Gets a collection of property values that override user settings.(Inherited from ComponentDesigner.)
	ShouldCodeSerialize	Obsolete. Gets or sets a value indicating whether to create a field declaration for the control in the code-behind file for the current design document during serialization.(Inherited from HtmlControlDesigner.)
	SuppressingDataSourceEvents	Indicates whether data source events have been disabled.(Inherited from HierarchicalDataSourceDesigner.)
	Tag	Gets an object representing the HTML markup element for the associated control.(Inherited from ControlDesigner.)
	TemplateGroups	Gets a collection of template groups, each containing one or more template definitions.(Inherited from ControlDesigner.)
	UsePreviewControl	Gets a value indicating whether the control designer uses a temporary preview control to generate the design-time HTML markup.(Inherited from ControlDesigner.)
	Verbs	Gets the design-time verbs supported by the component that is associated with the designer.(Inherited from ComponentDesigner.)
	ViewControl	Gets or sets a Web server control that can be used for previewing the design-time HTML markup.(Inherited from ControlDesigner.)
	ViewControlCreated	Gets or sets a value indicating whether a View control has been created for display on the design surface.(Inherited from ControlDesigner.)
	Visible	Gets a value that indicates whether the control is visible at design time.(Inherited from ControlDesigner.)

Methods

	Name	Description
	Configure()	Launches the configuration wizard for the underlying data source.(Inherited from HierarchicalDataSourceDesigner.)
	CreateErrorDesignTimeHtml(String^)	Creates HTML markup to display a specified error message at design time.(Inherited from ControlDesigner.)
	CreateErrorDesignTimeHtml(String^, Exception^)	Creates the HTML markup to display a specified exception error message at design time.(Inherited from ControlDesigner.)
	CreatePlaceHolderDesignTimeHtml()	Provides a simple rectangular placeholder representation that displays the type and ID of the control.(Inherited from ControlDesigner.)
	CreatePlaceHolderDesignTimeHtml(String^)	Provides a simple rectangular placeholder representation that displays the type and ID of the control, and also additional specified instructions or information.(Inherited from ControlDesigner.)
	CreateViewControl()	Returns a copy of the associated control for viewing or rendering on the design surface.(Inherited from ControlDesigner.)
	Dispose()	Releases all resources used by the ComponentDesigner.(Inherited from ComponentDesigner.)
	Dispose(Boolean)	Releases the unmanaged resources that are used by the HtmlControlDesigner object and optionally releases the managed resources.(Inherited from HtmlControlDesigner.)
	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.)
	Equals(Object^)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Finalize()	Attempts to free resources by calling Dispose(false) before the object is reclaimed by garbage collection.(Inherited from ComponentDesigner.)
	GetBounds()	Retrieves the coordinates of the rectangle representing the boundaries for the control as displayed on the design surface.(Inherited from ControlDesigner.)
	GetDesignTimeHtml()	Gets the HTML markup that is used to represent the control at design time.(Inherited from HierarchicalDataSourceDesigner.)
	GetDesignTimeHtml(DesignerRegionCollection^)	Retrieves the HTML markup to display the control and populates the collection with the current control designer regions.(Inherited from ControlDesigner.)
	GetEditableDesignerRegionContent(EditableDesignerRegion^)	Returns the content for an editable region of the design-time view of the associated control.(Inherited from ControlDesigner.)
	GetEmptyDesignTimeHtml()	Retrieves the HTML markup to represent a Web server control at design time that will have no visual representation at run time.(Inherited from ControlDesigner.)
	GetErrorDesignTimeHtml(Exception^)	Retrieves the HTML markup that provides information about the specified exception. (Inherited from ControlDesigner.)
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetPersistenceContent()	Retrieves the persistable inner HTML markup of the control at design time.(Inherited from ControlDesigner.)
	GetPersistInnerHtml()	Obsolete. Retrieves the persistable inner HTML markup of the control.(Inherited from ControlDesigner.)
	GetService(Type^)	Attempts to retrieve the specified type of service from the design mode site of the designer's component.(Inherited from ComponentDesigner.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	GetView(String^)	Gets the DesignerHierarchicalDataSourceView for the specified view.(Overrides HierarchicalDataSourceDesigner::GetView(String^).)
	GetViewNames()	Gets an array of names representing named views in the data source.
	GetViewRendering()	Retrieves an object that contains the design-time markup for the content and regions of the associated control.(Inherited from ControlDesigner.)
	Initialize(IComponent^)	Initializes the designer and loads the specified component.(Overrides ControlDesigner::Initialize(IComponent^).)
	InitializeExistingComponent(IDictionary^)	Reinitializes an existing component.(Inherited from ComponentDesigner.)
	InitializeNewComponent(IDictionary^)	Initializes a newly created component.(Inherited from ComponentDesigner.)
	InitializeNonDefault()	Obsolete. Initializes the settings for an imported component that is already initialized to settings other than the defaults.(Inherited from ComponentDesigner.)
	Invalidate()	Invalidates the whole area of the control that is displayed on the design surface and signals the control designer to redraw the control.(Inherited from ControlDesigner.)
	Invalidate(Rectangle)	Invalidates the specified area of the control that is displayed on the design surface and signals the control designer to redraw the control.(Inherited from ControlDesigner.)
	InvokeGetInheritanceAttribute(ComponentDesigner^)	Gets the InheritanceAttribute of the specified ComponentDesigner.(Inherited from ComponentDesigner.)
	IsPropertyBound(String^)	Obsolete. Retrieves a value indicating whether the specified property on the associated control is data-bound.(Inherited from ControlDesigner.)
	Localize(IDesignTimeResourceWriter^)	Uses the provided resource writer to persist the localizable properties of the associated control to a resource in the design host.(Inherited from ControlDesigner.)
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	OnAutoFormatApplied(DesignerAutoFormat^)	Called when a predefined, automatic formatting scheme has been applied to the associated control.(Inherited from ControlDesigner.)
	OnBehaviorAttached()	Obsolete. Called when a behavior is associated with the element.(Inherited from HtmlControlDesigner.)
	OnBehaviorDetaching()	Obsolete. Called when a behavior disassociates from the element.(Inherited from HtmlControlDesigner.)
	OnBindingsCollectionChanged(String^)	Obsolete. Called when the data-binding collection changes.(Inherited from ControlDesigner.)
	OnClick(DesignerRegionMouseEventArgs^)	Called by the design host when the user clicks the associated control at design time.(Inherited from ControlDesigner.)
	OnComponentChanged(Object^, ComponentChangedEventArgs^)	Called when the associated component changes.(Overrides ControlDesigner::OnComponentChanged(Object^, ComponentChangedEventArgs^).)
	OnComponentChanging(Object^, ComponentChangingEventArgs^)	Represents the method that will handle the ComponentChanging event for the associated control. (Inherited from ControlDesigner.)
	OnControlResize()	Obsolete. Called when the associated Web server control has been resized in the design host at design time.(Inherited from ControlDesigner.)
	OnDataSourceChanged(EventArgs^)	Raises the DataSourceChanged event when the properties of the data source have changed and the SuppressingDataSourceEvents property value is false.(Inherited from HierarchicalDataSourceDesigner.)
	OnPaint(PaintEventArgs^)	Called when the control designer draws the associated control on the design surface, if the CustomPaint value is true.(Inherited from ControlDesigner.)
	OnSchemaRefreshed(EventArgs^)	Raises the SchemaRefreshed event when the schema of the data source has changed and the SuppressingDataSourceEvents property value is false.(Inherited from HierarchicalDataSourceDesigner.)
	OnSetComponentDefaults()	Obsolete. Sets the default properties for the component.(Inherited from ComponentDesigner.)
	OnSetParent()	Provides a way to perform additional processing when the associated control is attached to a parent control.(Inherited from HtmlControlDesigner.)
	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^)	Allows a designer to change or remove items from the set of events that it exposes through a TypeDescriptor.(Inherited from ComponentDesigner.)
	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^)	Allows a designer to add to the set of attributes that it exposes through a TypeDescriptor.(Inherited from ComponentDesigner.)
	PreFilterEvents(IDictionary^)	Sets the list of events that are exposed at design-time for the TypeDescriptor object for the component.(Inherited from HtmlControlDesigner.)
	PreFilterProperties(IDictionary^)	Adds properties to or removes properties from the Properties grid in a design host at design time or provides new design-time properties that might correspond to properties on the associated control.(Inherited from ControlDesigner.)
	RaiseComponentChanged(MemberDescriptor^, Object^, Object^)	Notifies the IComponentChangeService that this component has been changed.(Inherited from ComponentDesigner.)
	RaiseComponentChanging(MemberDescriptor^)	Notifies the IComponentChangeService that this component is about to be changed.(Inherited from ComponentDesigner.)
	RaiseResizeEvent()	Obsolete. Raises the OnControlResize event.(Inherited from ControlDesigner.)
	RefreshSchema(Boolean)	Called by the designer host to refresh the schema of the underlying data source.(Overrides HierarchicalDataSourceDesigner::RefreshSchema(Boolean).)
	RegisterClone(Object^, Object^)	Registers internal data in a cloned control.(Inherited from ControlDesigner.)
	ResumeDataSourceEvents()	Restores data source events after they have been suppressed.(Inherited from HierarchicalDataSourceDesigner.)
	SetEditableDesignerRegionContent(EditableDesignerRegion^, String^)	Specifies the content for an editable region of the control at design time. (Inherited from ControlDesigner.)
	SetRegionContent(EditableDesignerRegion^, String^)	Specifies the content for an editable region in the design-time view of the control.(Inherited from ControlDesigner.)
	SetViewFlags(ViewFlags, Boolean)	Assigns the specified bitwise ViewFlags enumeration to the specified flag value.(Inherited from ControlDesigner.)
	SuppressDataSourceEvents()	Postpones all data source events until after the ResumeDataSourceEvents method is called.(Inherited from HierarchicalDataSourceDesigner.)
	ToString()	Returns a string that represents the current object.(Inherited from Object.)
	UpdateDesignTimeHtml()	Refreshes the design-time HTML markup for the associated Web server control by calling the GetDesignTimeHtml method.(Inherited from ControlDesigner.)

Events

	Name	Description
	DataSourceChanged	Occurs when any property of the associated data source changes.(Inherited from HierarchicalDataSourceDesigner.)
	SchemaRefreshed	Occurs after the schema has been refreshed.(Inherited from HierarchicalDataSourceDesigner.)

Explicit Interface Implementations

	Name	Description
	IDataSourceDesigner::DataSourceChanged	For a description of this member, see IDataSourceDesigner::DataSourceChanged.
	IDataSourceDesigner::SchemaRefreshed	For a description of this member, see IDataSourceDesigner::SchemaRefreshed.
	IDesignerFilter::PostFilterAttributes(IDictionary^)	For a description of this member, see the IDesignerFilter::PostFilterAttributes method.(Inherited from ComponentDesigner.)
	IDesignerFilter::PostFilterEvents(IDictionary^)	For a description of this member, see the IDesignerFilter::PostFilterEvents method.(Inherited from ComponentDesigner.)
	IDesignerFilter::PostFilterProperties(IDictionary^)	For a description of this member, see the IDesignerFilter::PostFilterProperties method.(Inherited from ComponentDesigner.)
	IDesignerFilter::PreFilterAttributes(IDictionary^)	For a description of this member, see the IDesignerFilter::PreFilterAttributes method.(Inherited from ComponentDesigner.)
	IDesignerFilter::PreFilterEvents(IDictionary^)	For a description of this member, see the IDesignerFilter::PreFilterEvents method.(Inherited from ComponentDesigner.)
	IDesignerFilter::PreFilterProperties(IDictionary^)	For a description of this member, see the IDesignerFilter::PreFilterProperties method.(Inherited from ComponentDesigner.)
	IDataSourceDesigner::Configure()	For a description of this member, see IDataSourceDesigner::Configure.
	IDataSourceDesigner::GetView(String^)	For a description of this member, see IDataSourceDesigner::GetView.
	IDataSourceDesigner::GetViewNames()	For a description of this member, see IDataSourceDesigner::GetViewNames.
	IDataSourceDesigner::RefreshSchema(Boolean)	For a description of this member, see IDataSourceDesigner::RefreshSchema.
	IDataSourceDesigner::ResumeDataSourceEvents()	For a description of this member, see IDataSourceDesigner::ResumeDataSourceEvents
	IDataSourceDesigner::SuppressDataSourceEvents()	For a description of this member, see IDataSourceDesigner::SuppressDataSourceEvents.
	ITreeDesigner::Children	For a description of this member, see the ITreeDesigner::Children property.(Inherited from ComponentDesigner.)
	ITreeDesigner::Parent	For a description of this member, see the ITreeDesigner::Parent property.(Inherited from ComponentDesigner.)
	IDataSourceDesigner::CanConfigure	For a description of this member, see IDataSourceDesigner::CanConfigure.
	IDataSourceDesigner::CanRefreshSchema	For a description of this member, see IDataSourceDesigner::CanRefreshSchema.

Version Information

.NET Framework
Available since 2.0

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.