IXpsOMCanvas::SetAccessibilityLongDescription method (xpsobjectmodel.h)
Sets the long (detailed) textual description of the object's contents. This text is used by accessibility clients to describe the object.
Syntax
HRESULT SetAccessibilityLongDescription(
[in] LPCWSTR longDescription
);
Parameters
[in] longDescription
The long (detailed) textual description of the object's contents. A NULL pointer clears the previously assigned value.
Return value
If the method succeeds, it returns S_OK; otherwise, it returns an HRESULT error code.
Remarks
The property that is set by this method corresponds to the AutomationProperties.HelpText attribute of the Canvas element in the document markup.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps | UWP apps] |
| Minimum supported server | Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps | UWP apps] |
| Target Platform | Windows |
| Header | xpsobjectmodel.h |