HtmlTextWriter.IsAttributeDefined Method (HtmlTextWriterAttribute)

Determines whether the specified markup attribute and its value are rendered during the next call to the RenderBeginTag method.

Namespace: System.Web.UI
Assembly: System.Web (in system.web.dll)

protected:
bool IsAttributeDefined (
	HtmlTextWriterAttribute key
)
protected boolean IsAttributeDefined (
	HtmlTextWriterAttribute key
)
protected function IsAttributeDefined (
	key : HtmlTextWriterAttribute
) : boolean
Not applicable.

Parameters

key

The HtmlTextWriterAttribute associated with the markup attribute.

Return Value

true if the attribute is rendered during the next call to the RenderBeginTag method; otherwise, false.

To obtain the value to be assigned to the HtmlTextWriterAttribute object, use the IsAttributeDefined(HtmlTextWriterAttribute,String) overload instead of this one.

The following code example shows how to use an override of the RenderBeginTag method in a class that inherits from the HtmlTextWriter class. The RenderBeginTag override checks whether a <font> markup element will be rendered. If so, the override calls the IsAttributeDefined method to check whether the <font> element contains a Size attribute. If not, the AddAttribute method calls the GetAttributeKey method, which defines the Size attribute and sets its value to 30pt.

// If the tagKey parameter is set to a <font> element
// but a size attribute is not defined on the element,
// the AddStyleAttribute method adds a size attribute
// and sets it to 30 point.
if ( tagKey == HtmlTextWriterTag::Font )
{
   if (  !IsAttributeDefined( HtmlTextWriterAttribute::Size ) )
   {
      AddAttribute( GetAttributeKey( "size" ), "30pt" );
   }
}

// If the tagKey parameter is set to a <font> element
// but a size attribute is not defined on the element,
// the AddStyleAttribute method call adds a size attribute
// and sets it to 30 point. 
if (tagKey.Equals(HtmlTextWriterTag.Font)) {
    if (!(IsAttributeDefined(HtmlTextWriterAttribute.Size))) {
        AddAttribute(GetAttributeKey("size"), "30pt");
    }
}

Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

Community Additions

ADD
Show: