LoginViewDesigner Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Provides design-time support in a visual designer for the LoginView Web server control.
public ref class LoginViewDesigner : System::Web::UI::Design::ControlDesignerpublic class LoginViewDesigner : System.Web.UI.Design.ControlDesignertype LoginViewDesigner = class
inherit ControlDesignerPublic Class LoginViewDesigner
Inherits ControlDesigner- Inheritance
Examples
The following code example shows how to extend the LoginViewDesigner class to change the appearance and behavior of controls that are derived from the LoginView control at design time.
The example derives the MyLoginView control from the LoginView. The MyLoginView is a copy of the LoginView control. The example also derives the MyLoginViewDesigner class from the LoginViewDesigner class and applies a DesignerAttribute attribute for the MyLoginViewDesigner on the MyLoginView control.
The MyLoginViewDesigner control overrides the following LoginViewDesigner members:
The PreFilterProperties method to make the NamingContainer property visible in the Properties grid at design time.
The GetDesignTimeHtml method to draw an orange border around the control to make its extent more visible.
The GetErrorDesignTimeHtml method to generate the markup for a placeholder that includes the error message, which is rendered in red, bold text.
The GetEmptyDesignTimeHtml method to generate the markup for a placeholder that contains the names of the role groups that are defined for the control.
The Initialize method to throw an ArgumentException exception, if the associated control is not a
MyLoginViewobject.
using System;
using System.Web;
using System.Web.UI.WebControls;
using System.Web.UI.Design;
using System.Web.UI.Design.WebControls;
using System.Collections;
using System.ComponentModel;
using System.Security.Permissions;
namespace Examples.CS.WebControls.Design
{
// The MyLoginView is a copy of the LoginView.
[AspNetHostingPermission(SecurityAction.Demand,
Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermission(SecurityAction.InheritanceDemand,
Level = AspNetHostingPermissionLevel.Minimal)]
[Designer(typeof(Examples.CS.WebControls.Design.MyLoginViewDesigner))]
public class MyLoginView : LoginView
{
} // MyLoginView
// Override members of the LoginViewDesigner.
[ReflectionPermission(SecurityAction.Demand, Flags=ReflectionPermissionFlag.MemberAccess)]
public class MyLoginViewDesigner : LoginViewDesigner
{
// Generate the design-time markup for the control when an error occurs.
protected override string GetErrorDesignTimeHtml(Exception ex)
{
// Write the error message text in red, bold.
string errorRendering =
"<span style=\"font-weight:bold; color:Red; \">" +
ex.Message + "</span>";
return CreatePlaceHolderDesignTimeHtml(errorRendering);
} // GetErrorDesignTimeHtml
// Generate the design-time markup for the control
// when the template is empty.
protected override string GetEmptyDesignTimeHtml()
{
// Generate a design-time placeholder containing the names of all
// the role groups.
MyLoginView myLoginViewCtl = (MyLoginView)ViewControl;
RoleGroupCollection roleGroups = myLoginViewCtl.RoleGroups;
string roleNames = null;
// If there are any role groups, form a string of their names.
if (roleGroups.Count > 0)
{
roleNames = "Role Groups: <br /> " +
roleGroups[0].ToString();
for( int rgX = 1; rgX < roleGroups.Count; rgX++ )
roleNames +=
"<br /> " + roleGroups[rgX].ToString();
}
return CreatePlaceHolderDesignTimeHtml( roleNames);
} // GetEmptyDesignTimeHtml
// Shadow control properties with design-time properties.
protected override void PreFilterProperties(IDictionary properties)
{
// Call the base method first.
base.PreFilterProperties(properties);
// Make the NamingContainer visible in the Properties grid.
PropertyDescriptor selectProp =
(PropertyDescriptor)properties["NamingContainer"];
properties["NamingContainer"] =
TypeDescriptor.CreateProperty(selectProp.ComponentType,
selectProp, BrowsableAttribute.Yes);
} // PreFilterProperties
// Generate the design-time markup.
public override string GetDesignTimeHtml(DesignerRegionCollection regions)
{
// Make the control more visible in the designer.
// Enclose the markup in a table with an orange border.
const string openTableMarkup =
"<table><tr><td style=\"border:4 solid #FF7F00;\">";
const string closeTableMarkup = "</td></tr></table>";
// Call the base method to generate the markup.
string markup = base.GetDesignTimeHtml(regions);
return openTableMarkup + markup + closeTableMarkup;
} // GetDesignTimeHtml
public override void Initialize(IComponent component)
{
// Ensure that only a MyLoginView can be created in this designer.
if (!(component is MyLoginView))
throw new ArgumentException();
// Call the base method to generate the markup.
base.Initialize(component);
} // Initialize
} // MyLoginViewDesigner
} // Examples.CS.WebControls.Design
Imports System.Web
Imports System.Web.UI.WebControls
Imports System.Web.UI.Design
Imports System.Web.UI.Design.WebControls
Imports System.Collections
Imports System.ComponentModel
Imports System.Security.Permissions
Imports System.IO
Namespace Examples.VB.WebControls.Design
' The MyLoginView is a copy of the LoginView.
<AspNetHostingPermission(SecurityAction.Demand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
<AspNetHostingPermission(SecurityAction.InheritanceDemand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
<Designer(GetType(Examples.VB.WebControls.Design.MyLoginViewDesigner))> _
Public Class MyLoginView
Inherits LoginView
End Class
' Override members of the LoginViewDesigner.
<ReflectionPermission(SecurityAction.Demand, Flags:=ReflectionPermissionFlag.MemberAccess)> _
Public Class MyLoginViewDesigner
Inherits LoginViewDesigner
' Generate the design-time markup for the control when an error occurs.
Protected Overrides Function GetErrorDesignTimeHtml( _
ByVal ex As Exception) As String
' Write the error message text in red, bold.
Dim errorRendering As String = _
"<span style=""font-weight:bold; color:Red; "">" & _
ex.Message & "</span>"
Return CreatePlaceHolderDesignTimeHtml(errorRendering)
End Function ' GetErrorDesignTimeHtml
' Generate the design-time markup for the control
' when the template is empty.
Protected Overrides Function GetEmptyDesignTimeHtml() As String
' Generate a design-time placeholder containing the names of all
' the role groups.
Dim myLoginViewCtl As MyLoginView = CType(ViewControl, MyLoginView)
Dim roleGroups As RoleGroupCollection = myLoginViewCtl.RoleGroups
Dim RoleNames As String = Nothing
Dim rgX As Integer
' If there are any role groups, form a string of their names.
If roleGroups.Count > 0 Then
roleNames = "Role Groups: <br /> " & _
roleGroups(0).ToString()
For rgX = 1 To roleGroups.Count - 1
roleNames &= "<br /> " & _
roleGroups(rgX).ToString()
Next rgX
End If
Return CreatePlaceHolderDesignTimeHtml(roleNames)
End Function ' GetEmptyDesignTimeHtml
' Shadow control properties with design-time properties.
Protected Overrides Sub PreFilterProperties( _
ByVal properties As IDictionary)
' Call the base method first.
MyBase.PreFilterProperties(properties)
' Make the NamingContainer visible in the Properties grid.
Dim selectProp As PropertyDescriptor = _
CType(properties("NamingContainer"), PropertyDescriptor)
properties("NamingContainer") = _
TypeDescriptor.CreateProperty(selectProp.ComponentType, _
selectProp, BrowsableAttribute.Yes)
End Sub
' Generate the design-time markup.
Public Overrides Function GetDesignTimeHtml( _
ByVal regions As DesignerRegionCollection) As String
' Make the control more visible in the designer.
' Enclose the markup in a table with an orange border.
Dim openTableMarkup As String = _
"<table><tr><td style=""border:4 solid #FF7F00;"">"
Dim closeTableMarkup As String = "</td></tr></table>"
' Call the base method to generate the markup.
Dim markup As String = MyBase.GetDesignTimeHtml(regions)
Return openTableMarkup & markup & closeTableMarkup
End Function ' GetDesignTimeHtml
' Generate the design time markup.
Public Overrides Sub Initialize(ByVal component As IComponent)
' Ensure that only a MyLoginView can be created in this designer.
If Not TypeOf component Is MyLoginView Then
Throw New ArgumentException()
End If
' Call the base method to generate the markup.
MyBase.Initialize(component)
End Sub
End Class
End Namespace ' Examples.VB.WebControls.Design
Remarks
The LoginView control renders one of its templates, determined by whether a user is logged on to the host Web site, and the roles that contain the logged-on user account.
In a visual designer, when you switch from Source to Design view, the markup source code that describes the LoginView control is parsed and a design-time version of the control is created on the design surface. When you switch back to Source view, the design-time control is persisted to the markup source code and edited into the markup for the Web page. The LoginViewDesigner class provides design-time support for the LoginView control.
The ActionLists property returns a DesignerActionListCollection object, which typically contains an object that is derived from the DesignerActionList class for each level in the inheritance tree of the designer. The TemplateGroups property returns a collection of template groups for the templates of the associated LoginView control. The UsePreviewControl property always returns true, indicating that the designer creates a temporary copy of the associated LoginView control to generate the design-time markup.
The LoginViewDesigner class methods provide the following functionality:
The GetDesignTimeHtml methods return the markup that is used to render the associated LoginView control at design time. The GetEmptyDesignTimeHtml method gets the markup that renders a placeholder for the associated control at design time when the current template is not defined. The GetErrorDesignTimeHtml method provides the markup that renders the associated control at design time when an error has occurred.
The GetEditableDesignerRegionContent method returns a serialized copy of the current template for the associated LoginView control. The SetEditableDesignerRegionContent method sets a region of the associated control from a serialized copy of a control template.
The Initialize method prepares the designer to view, edit, and design the associated LoginView control. The OnComponentChanged method is called when there is a change to the associated control. The PreFilterProperties method is used to remove properties from, add additional properties to, or shadow properties of the associated control.
Constructors
| LoginViewDesigner() |
Initializes a new instance of the LoginViewDesigner class. |
Properties
| ActionLists |
Gets the designer action list collection for this designer. |
| 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) |
| 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 |
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) |
| SetTextualDefaultProperty | (Inherited from ComponentDesigner) |
| 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) |
| Tag |
Gets an object representing the HTML markup element for the associated control. (Inherited from ControlDesigner) |
| TemplateGroups |
Gets a collection of template groups for the fields of the associated control. |
| UsePreviewControl |
Gets a value indicating whether the designer should use a temporary copy rather than the actual control that is associated with the designer to generate the design-time markup. |
| 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 |
| Visible |
Gets a value that indicates whether the control is visible at design time. (Inherited from ControlDesigner) |
Methods
| CreateErrorDesignTimeHtml(String, Exception) |
Creates the HTML markup to display a specified exception error message at design time. (Inherited from ControlDesigner) |
| CreateErrorDesignTimeHtml(String) |
Creates HTML markup to display a specified 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) |
| 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 markup that is used to render the associated control at design time. |
| GetDesignTimeHtml(DesignerRegionCollection) |
Gets the markup that is used to render the associated control at design time and populates a collection of designer regions. |
| GetEditableDesignerRegionContent(EditableDesignerRegion) |
Returns a serialized copy of the current template that is used to render the associated control at design time. |
| GetEmptyDesignTimeHtml() |
Gets the markup that renders a placeholder for the associated control at design time when the current template is not defined. |
| GetErrorDesignTimeHtml(Exception) |
Provides the markup that renders the associated control at design time when an error has occurred. |
| 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) |
| GetViewRendering() |
Retrieves an object that contains the design-time markup for the content and regions of the associated control. (Inherited from ControlDesigner) |
| Initialize(IComponent) |
Prepares the designer to view, edit, and design the associated control. |
| InitializeExistingComponent(IDictionary) |
Reinitializes an existing component. (Inherited from ComponentDesigner) |
| InitializeNewComponent(IDictionary) |
Initializes a newly created component. (Inherited from ComponentDesigner) |
| InitializeNonDefault() |
Obsolete.
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() |
Called when the control designer is attached to a Behavior object. (Inherited from ControlDesigner) |
| 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 there is a change to the control that is associated with this designer. |
| 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) |
| OnPaint(PaintEventArgs) |
Called when the control designer draws the associated control on the design surface, if the CustomPaint value is |
| OnSetComponentDefaults() |
Obsolete.
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) |
Used by the designer to remove properties from or add properties to the display in the Properties grid or to shadow properties of the associated control. |
| 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) |
| RegisterClone(Object, Object) |
Registers internal data in a cloned control. (Inherited from ControlDesigner) |
| SetEditableDesignerRegionContent(EditableDesignerRegion, String) |
Sets a region of the associated control from a serialized copy of a control template. |
| 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) |
| 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) |
