Edit

Share via

VisualStyleRenderer.IsElementDefined(VisualStyleElement) Method

Definition

Namespace:
System.Windows.Forms.VisualStyles
Assembly:
System.Windows.Forms.dll
Source:
VisualStyleRenderer.cs
Source:
VisualStyleRenderer.cs
Source:
VisualStyleRenderer.cs

Determines whether the specified visual style element is defined by the current visual style.

public:
 static bool IsElementDefined(System::Windows::Forms::VisualStyles::VisualStyleElement ^ element);
public static bool IsElementDefined(System.Windows.Forms.VisualStyles.VisualStyleElement element);
static member IsElementDefined : System.Windows.Forms.VisualStyles.VisualStyleElement -> bool
Public Shared Function IsElementDefined (element As VisualStyleElement) As Boolean

Parameters

element
VisualStyleElement

A VisualStyleElement whose class and part combination will be verified.

Returns

Boolean

true if the combination of the ClassName and Part properties of element are defined; otherwise, false.

Exceptions

InvalidOperationException

The operating system does not support visual styles.

-or-

Visual styles are disabled by the user in the operating system.

-or-

Visual styles are not applied to the client area of application windows.

Examples

The following code example demonstrates how to use the IsElementDefined method to determine whether to initialize a VisualStyleRenderer to a given VisualStyleElement. This code example is part of a larger example provided for the VisualStyleRenderer class overview.

    // Set the VisualStyleRenderer to a new element.
private:
    bool SetRenderer(VisualStyleElement^ element)
    {
        if (!VisualStyleRenderer::IsElementDefined(element))
        {
            return false;
        }

        if (renderer == nullptr)
        {
            renderer = gcnew VisualStyleRenderer(element);
        }
        else
        {
            renderer->SetParameters(element);
        }

        return true;
    }

// Set the VisualStyleRenderer to a new element.
private bool SetRenderer(VisualStyleElement element)
{
    if (!VisualStyleRenderer.IsElementDefined(element))
    {
        return false;
    }

    if (renderer == null)
    {
        renderer = new VisualStyleRenderer(element);
    }
    else
    {
        renderer.SetParameters(element);
    }

    return true;
}

' Set the VisualStyleRenderer to a new element.
Private Function SetRenderer(ByVal element As _
    VisualStyleElement) As Boolean

    If Not VisualStyleRenderer.IsElementDefined(element) Then
        Return False
    End If

    If renderer Is Nothing Then
        renderer = New VisualStyleRenderer(element)
    Else
        renderer.SetParameters(element)
    End If

    Return True
End Function

Remarks

This method checks the value of the IsSupported property internally.

Applies to