GridItemPattern.ColumnSpanProperty Field

Definition

Namespace:

System.Windows.Automation

Assembly:

UIAutomationClient.dll

Identifies the ColumnSpan property.

public: static initonly System::Windows::Automation::AutomationProperty ^ ColumnSpanProperty;

public static readonly System.Windows.Automation.AutomationProperty ColumnSpanProperty;

 staticval mutable ColumnSpanProperty : System.Windows.Automation.AutomationProperty

Public Shared ReadOnly ColumnSpanProperty As AutomationProperty 

Field Value

AutomationProperty

Examples

In the following example, a GridItemPattern object obtained from a target control is passed into a function that retrieves the current GridItemPattern property values.

///--------------------------------------------------------------------
/// <summary>
/// Gets the current property values from target.
/// </summary>
/// <param name="gridItemPattern">
/// A GridItemPattern control pattern obtained from 
/// an automation element representing a target control.
/// </param>
/// <param name="automationProperty">
/// The automation property of interest.
/// </param>
/// <returns>
/// An integer object representing the requested property value.
/// </returns>
///--------------------------------------------------------------------
private object GetGridItemProperties(
    GridItemPattern gridItemPattern,
    AutomationProperty automationProperty)
{
    if (automationProperty.Id ==
        GridItemPattern.ColumnProperty.Id)
    {
        return gridItemPattern.Current.Column;
    }
    if (automationProperty.Id ==
        GridItemPattern.RowProperty.Id)
    {
        return gridItemPattern.Current.Row;
    }
    if (automationProperty.Id ==
        GridItemPattern.ColumnSpanProperty.Id)
    {
        return gridItemPattern.Current.ColumnSpan;
    }
    if (automationProperty.Id ==
        GridItemPattern.RowSpanProperty.Id)
    {
        return gridItemPattern.Current.RowSpan;
    }

    return null;
}

'''--------------------------------------------------------------------
''' <summary>
''' Gets the current property values from target.
''' </summary>
''' <param name="gridItemPattern">
''' A GridItemPattern control pattern obtained from 
''' an automation element representing a target control.
''' </param>
''' <param name="automationProperty">
''' The automation property of interest.
''' </param>
''' <returns>
''' An integer object representing the requested property value.
''' </returns>
'''--------------------------------------------------------------------
Private Function GetGridItemProperties( _
ByVal gridItemPattern As GridItemPattern, _
ByVal automationProperty As AutomationProperty) As Object
    If automationProperty.Id = gridItemPattern.ColumnProperty.Id Then
        Return gridItemPattern.Current.Column
    End If
    If automationProperty.Id = gridItemPattern.RowProperty.Id Then
        Return gridItemPattern.Current.Row
    End If
    If automationProperty.Id = gridItemPattern.ColumnSpanProperty.Id Then
        Return gridItemPattern.Current.ColumnSpan
    End If
    If automationProperty.Id = gridItemPattern.RowSpanProperty.Id Then
        Return gridItemPattern.Current.RowSpan
    End If

    Return Nothing

End Function 'GetGridItemProperties

Remarks

This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in GridItemPatternIdentifiers.