IAnnotationProvider IAnnotationProvider IAnnotationProvider IAnnotationProvider Interface

Definition

Exposes the properties of an annotation in a document. Implement this interface in order to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.Annotation.

public : interface IAnnotationProvider
public interface IAnnotationProvider
Public Interface IAnnotationProvider
// You can't instantiate an interface directly in JavaScript. You can use objects that implement the interface, however.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

The Annotation control pattern is used to expose the properties of an annotation in a document. One example is a comment balloon that is in the margin of a document and is connected to some document text or a spreadsheet cell. For more info on what this pattern is for, see Annotation Control Pattern.

IAnnotationProvider isn't implemented by any existing Windows Runtime automation peers. The interface exists so that custom control authors can support the automation pattern in a custom control, and implement their automation support using the same Windows Runtime managed or C++ API as they use to define control logic or other automation support.

Use AnnotationPatternIdentifiers if you want to reference the IAnnotationProvider pattern properties from control code when you fire automation events or call RaisePropertyChangedEvent.

Properties

AnnotationTypeId AnnotationTypeId AnnotationTypeId AnnotationTypeId

Gets the annotation type identifier of this annotation.

public : int AnnotationTypeId { get; }
public int AnnotationTypeId { get; }
Public ReadOnly Property AnnotationTypeId As int
var int = iAnnotationProvider.annotationTypeId;
Value
int int int int

The annotation type identifier of this annotation.

AnnotationTypeName AnnotationTypeName AnnotationTypeName AnnotationTypeName

Gets the name of this annotation type.

public : Platform::String AnnotationTypeName { get; }
public string AnnotationTypeName { get; }
Public ReadOnly Property AnnotationTypeName As string
var string = iAnnotationProvider.annotationTypeName;
Value
Platform::String string string string

The name of this annotation type.

Author Author Author Author

Gets the name of the annotation author.

public : Platform::String Author { get; }
public string Author { get; }
Public ReadOnly Property Author As string
var string = iAnnotationProvider.author;
Value
Platform::String string string string

The name of the annotation author.

DateTime DateTime DateTime DateTime

Gets the date and time when this annotation was created.

public : Platform::String DateTime { get; }
public string DateTime { get; }
Public ReadOnly Property DateTime As string
var string = iAnnotationProvider.dateTime;
Value
Platform::String string string string

The date and time when this annotation was created.

Target Target Target Target

Gets the UI Automation element that is being annotated.

public : IRawElementProviderSimple Target { get; }
public IRawElementProviderSimple Target { get; }
Public ReadOnly Property Target As IRawElementProviderSimple
var iRawElementProviderSimple = iAnnotationProvider.target;

See Also