Share via

2.4.7 Application Data For VtHyperlink

  • Article

The following algorithm specifies how hyperlink properties, as specified in [MS-OSHARED] section 2.3.3.1.18, are associated with content in a document construct their dwApp field value.

  • If the hyperlink is associated with an OfficeArtFSP shape, as specified in [MS-ODRAW] section 2.2.40, the dwApp value MUST be 0xFFFFFFFF. Otherwise the hyperlink MUST be associated with a picture, an external link to a picture source, or other document content.

  • If the hyperlink is associated directly with a picture, as opposed to the hyperlink field associated with the picture, or an external link to a picture source, the dwApp value MUST be set to an FcCompressed structure that specifies the starting offset of the field result in the WordDocument Stream associated with the picture. For further specification on field results, see Plcfld.

  • If the hyperlink is associated with any other type of document content, including the hyperlink field of a WordArt shape or picture, the dwApp value MUST be set to an unsigned 4-byte integer that specifies the index into a Plcfld. The specified Plcfld item corresponds to the field begin character of the hyperlink field in the document content associated with the hyperlink property.

    The hyperlink properties that have dwApp set to an index into a Plcfld MUST conform to a specific ordering relative to each other when written. They MUST be written within the property set hyperlink property array VtHyperlinks, as specified in [MS-OSHARED] section 2.3.3.1.21, grouped according to the document Plcfld to which the indices apply, in the following order:

  1. Main Document links.

  2. Footnote Document links.

  3. Header Document links.

  4. Comment Document links.

  5. Endnote Document links.

  6. Textbox Document links.

  7. Header Textbox Document links.

    Within these groupings the hyperlink properties MUST be ordered from largest index to smallest index.

    Example:

    A document contains two hyperlink fields in the Main Document, and two hyperlink fields in the Footnote Document. The field indices for the hyperlinks (h1M, and h2M) in the Main Document are 1 and 4 respectively. The field indices for the hyperlinks (h1F, and h2F) in the Footnote Document are 0 and 3 respectively.

    The hyperlink properties in this example MUST be written in the order: h2M, h1M, h2F, h1F.