XhtmlTextWriter.IsValidFormAttribute(String) Method

Reference

Definition

Namespace:: System.Web.UI

Assembly:: System.Web.dll

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.

Checks an XHTML attribute to ensure that it can be rendered in the opening tag of a <form> element.

public:
 override bool IsValidFormAttribute(System::String ^ attributeName);

public override bool IsValidFormAttribute (string attributeName);

override this.IsValidFormAttribute : string -> bool

Public Overrides Function IsValidFormAttribute (attributeName As String) As Boolean

Parameters

attributeName: String

The attribute name to check.

Returns

Boolean

true if the attribute can be applied to a <form> element; otherwise, false.

Examples

The following code example is part of a larger example that creates a custom Label control and an adapter that renders the content of the control as XHTML.

This code example demonstrates how to create a Boolean variable named attTest and set it to the return value that results from calling the IsValidFormAttribute method with the parameter value "style". If the IsValidFormAttribute method returns true, the styles that are associated with the control are rendered using the HtmlTextWriter.EnterStyle and HtmlTextWriter.ExitStyle methods. If the attTest value is false, the styles are not rendered. Instead, the page displays the text for the control, a <br/> element that is rendered by the WriteBreak method, and a text string informing the user that the XHTML content of the control has rendered conditionally.

This code example is part of a larger example provided for the XhtmlTextWriter class.

protected override void Render(HtmlTextWriter writer)
{
    // Create an instance of the XhtmlTextWriter class,
    // named w, and cast the HtmlTextWriter passed 
    // in the writer parameter to w.
    XhtmlTextWriter w = new XhtmlTextWriter(writer);

    // Create a string variable, named value, to hold
    // the control's Text property value.
    String value = Control.Text;

    // Create a Boolean variable, named attTest,
    // to test whether the Style attribute is 
    // valid in the page that the control is
    // rendered to.
    Boolean attTest = w.IsValidFormAttribute("style");

    // Check whether attTest is true or false.
    // If true, a style is applied to the XHTML
    // content. If false, no style is applied.
    if (attTest)
        w.EnterStyle(Control.ControlStyle);

    // Write the Text property value of the control,
    // a <br> element, and a string. Consider encoding the value using WriteEncodedText.
    w.Write(value);
    w.WriteBreak();
    w.Write("This control conditionally rendered its styles for XHTML.");

    // Check whether attTest is true or false.
    // If true, the XHTML style is closed.
    // If false, nothing is rendered.
    if (attTest)
        w.ExitStyle(Control.ControlStyle);
}

' Override the Render method.
Protected Overrides Sub Render(ByVal writer As HtmlTextWriter)

    ' Create an instance of the XhtmlTextWriter class, 
    ' named w, and cast the HtmlTextWriter passed 
    ' in the writer parameter to w.
    Dim w As XhtmlTextWriter = New XhtmlTextWriter(writer)

    ' Create a string variable, named value, to hold
    ' the control's Text property value.
    Dim value As String = Control.Text

    ' Create a Boolean variable, named attTest,
    ' to test whether the Style attribute is 
    ' valid in the page that the control is
    ' rendered to.
    Dim attTest As Boolean = w.IsValidFormAttribute("style")

    ' Check whether attTest is true or false.
    ' If true, a style is applied to the XHTML
    ' content. If false, no style is applied.
    If (attTest = True) Then
        w.EnterStyle(Control.ControlStyle)
    End If

    ' Write the Text property value of the control,
    ' a <br> element, and a string. Consider encoding the value using WriteEncodedText.
    w.Write(value)
    w.WriteBreak()
    w.Write("This control conditionally rendered its styles for XHTML.")

    ' Check whether attTest is true or false.
    ' If true, the XHTML style is closed.
    ' If false, nothing is rendered.
    If (attTest = True) Then
        w.ExitStyle(Control.ControlStyle)
    End If

End Sub

Remarks

This method is useful to conditionally render an attribute depending on whether it is supported by the XHTML document type of the requesting device.

Applies to

Del via