ITextRangeProvider.GetAttributeValue(Int32) Method

Reference

Definition

Namespace:: System.Windows.Automation.Provider

Assembly:: UIAutomationProvider.dll

Assemblies:: UIAutomationProvider.dll, UIAutomationTypes.dll

Assembly:: UIAutomationTypes.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.

Retrieves the value of the specified attribute across the text range.

public:
 System::Object ^ GetAttributeValue(int attribute);

public object GetAttributeValue (int attribute);

abstract member GetAttributeValue : int -> obj

Public Function GetAttributeValue (attribute As Integer) As Object

Parameters

attribute: Int32

The text attribute.

Returns

Object

Retrieves an object representing the value of the specified attribute. For example, GetAttributeValue(TextPattern.FontNameAttribute) would return a string that represents the font name of the text range while GetAttributeValue(TextPattern.IsItalicAttribute) would return a value of type Boolean.

Returns MixedAttributeValue if the value of the specified attribute varies over the text range.

Returns NotSupported if the specified attribute is not supported by the provider or the control.

Exceptions

ArgumentException

If the specified attribute is not valid.

Remarks

There is no differentiation between hidden and visible text.

Applies to