IAnnotationProvider interface

Applies to Windows and Windows Phone

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.

Syntax


public interface IAnnotationProvider

Attributes

[Version(0x06020000)]
[WebHostHidden()]

Members

The IAnnotationProvider interface has these types of members:

Properties

The IAnnotationProvider interface has these properties.

PropertyAccess typeDescription

AnnotationTypeId

Read-onlyGets the annotation type identifier of this annotation.

AnnotationTypeName

Read-onlyGets the name of this annotation type.

Author

Read-onlyGets the name of the annotation author.

DateTime

Read-onlyGets the date and time when this annotation was created.

Target

Read-onlyGets the UI Automation element that is being annotated.

 

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++ APIs 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.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

Windows.UI.Xaml.Automation.Provider
Windows::UI::Xaml::Automation::Provider [C++]

Metadata

Windows.winmd

See also

AnnotationPatternIdentifiers
IAnnotationProvider (COM)
Custom automation peers
Annotation Control Pattern

 

 

Show:
© 2014 Microsoft. All rights reserved.