SetStructElemExpansionA

带标签 PDF & 辅助功能

描述

末尾的 A 表示 ANSI（char）DLL 入口点，ActiveX/COM 接口仅公开 Unicode 形式。其行为与 SetStructElemExpansion 相同，字符串参数会按照当前的 SetAnsiMode 代码页进行解释

在当前位于 tag stack 顶部的结构元素上设置 /E（expansion text）条目。Expansion text 是元素中缩写或首字母缩略词的完整拼写形式，例如内容为 WWW 的 Span 元素可以使用 World Wide Web，内容为 ISO 的 Span 可以使用 International Organization for Standardization

屏幕阅读器和其他辅助技术会朗读 expansion text，而不是尝试读出缩写字符。对于无法按单词读出的缩写，这对无障碍访问至关重要

语法

Delphi

Function DLSetStructElemExpansionA(InstanceID: Integer; Expansion: PAnsiChar): Integer;

DLL

int DLSetStructElemExpansionA(int InstanceID, const char * Expansion);

参数

Expansion	当前结构元素中缩写或首字母缩略词的完整展开文本。传入空字符串可清除之前设置的值

返回值

成功返回 1；如果当前没有打开的结构元素或没有选中文档，则返回 0

备注

目标元素位于 tag stack 顶部时，应在 BeginTag 后立即调用此函数；也可以在匹配的 EndTag 调用前的任意时刻调用

/E 条目定义于 ISO 32000-1 §14.9.5。它作为 PDF text string 写入结构元素字典，并且不同于其他文本属性

/E (Expansion) — 缩写或首字母缩略词的完整拼写形式，用于屏幕阅读器朗读缩写内联内容
/Alt（见 SetStructElemAltText）— 为无法以视觉形式呈现的元素（图像、图形、公式）提供完整替代说明
/ActualText（见 SetStructElemActualText）— 为提取文本可能出错的字形序列（连字、字形变体）提供精确 Unicode 替代文本

PDF/UA-1（ISO 14289-1 §7.2）要求每段文本的自然语言都能明确确定。对于无法按单词读出的缩写和首字母缩略词，/E 是提供该信息的标准机制

请把 /E 应用到包住该缩写的最内层元素，通常是 Span 元素。展开文本只作用于该元素的内容，不会被子元素继承

示例

// Tag an abbreviation with its expansion
PDFlib.BeginTag('Span', '', '');
PDFlib.SetStructElemExpansion('World Wide Web');
PDFlib.WriteText('WWW');
PDFlib.EndTag;

// Tag a standards acronym
PDFlib.BeginTag('Span', '', '');
PDFlib.SetStructElemExpansion('International Organization for Standardization');
PDFlib.WriteText('ISO');
PDFlib.EndTag;

另请参阅

BeginTag, SetStructElemAltText, SetStructElemActualText, SetStructElemLang, GetPDFUADiagnostics