Share via


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 class IAnnotationProvider
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.Guid(2512000023, 17463, 17691, 148, 97, 5, 10, 73, 181, 157, 6)]
struct IAnnotationProvider
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.Guid(2512000023, 17463, 17691, 148, 97, 5, 10, 73, 181, 157, 6)]
public interface IAnnotationProvider
Public Interface IAnnotationProvider
Attributes

Windows requirements

Device family
Windows 10 (introduced in 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v1.0)

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

Gets the annotation type identifier of this annotation.

AnnotationTypeName

Gets the name of this annotation type.

Author

Gets the name of the annotation author.

DateTime

Gets the date and time when this annotation was created.

Target

Gets the UI Automation element that is being annotated.

Applies to

See also