THotPDF.AddStructureElement и помощни функции за Tagged PDF
Тази страница описва текущите помощни функции на THotPDF за Tagged PDF и дървета на структурата PDF/UA. Идентификаторите в кода съответстват на публичните декларации
Текущ Delphi интерфейс
function AddStructureElement(const Role: AnsiString; Parent: THPDFDictionaryObject;
PageIndex: Integer = -1; MCID: Integer = -1): THPDFDictionaryObject; overload;
function AddStructureElement(const Role: AnsiString; Parent: THPDFDictionaryObject;
PageIndex: Integer; MCID: Integer;
const AltText: AnsiString; const ActualText: AnsiString): THPDFDictionaryObject; overload;
function AddStructureElement(const Role: AnsiString; Parent: THPDFDictionaryObject;
PageIndex: Integer; MCID: Integer;
const AltText: AnsiString; const ActualText: AnsiString;
const IDStr: AnsiString): THPDFDictionaryObject; overload;
function AddStructureElement(T: THPDFStandardStructureType; Parent: THPDFDictionaryObject;
PageIndex: Integer = -1; MCID: Integer = -1): THPDFDictionaryObject; overload;
procedure SetStructureElementLanguage(Elem: THPDFDictionaryObject; const Lang: AnsiString);
procedure SetStructureElementExpansionText(Elem: THPDFDictionaryObject; const ExpansionText: AnsiString);
procedure SetStructureElementTitle(Elem: THPDFDictionaryObject; const Title: AnsiString);
procedure AddStructRoleMap(const SourceRole: AnsiString; const TargetRole: AnsiString);
function BeginTaggedContent(const Role: AnsiString; Parent: THPDFDictionaryObject;
const Lang: AnsiString = ''; const Alt: AnsiString = '';
const ActualText: AnsiString = ''; const ExpansionText: AnsiString = ''): THPDFDictionaryObject;
procedure EndTaggedContent;
function EmitTaggedHeading(Level: Integer; Parent: THPDFDictionaryObject; X, Y: Single; const Text: WideString): THPDFDictionaryObject;
function BeginTaggedList(Parent: THPDFDictionaryObject; const NumberingStyle: AnsiString = 'None'): THPDFDictionaryObject;
function EmitTaggedListItem(ListElem: THPDFDictionaryObject; LblX, LblY: Single; const LabelText: WideString; BodyX, BodyY: Single; const BodyText: WideString): THPDFDictionaryObject;
function BeginTaggedTable(Parent: THPDFDictionaryObject): THPDFDictionaryObject;
function AddTaggedTableRow(TableElem: THPDFDictionaryObject): THPDFDictionaryObject;
function EmitTaggedTableHeader(TRElem: THPDFDictionaryObject; X, Y: Single; const Text: WideString; const Scope: AnsiString): THPDFDictionaryObject;
function EmitTaggedTableCell(TRElem: THPDFDictionaryObject; X, Y: Single; const Text: WideString): THPDFDictionaryObject;
function BeginTaggedFigure(Parent: THPDFDictionaryObject; const AltText: AnsiString; const BBox: array of Single): THPDFDictionaryObject;
procedure EndTaggedFigure;
procedure RegisterAnnotForStructure(AnnotDict: THPDFDictionaryObject; StructElem: THPDFDictionaryObject);
function StandardStructureTypeToName(T: THPDFStandardStructureType): AnsiString;
function IsStandardStructureType(const Name: AnsiString): Boolean;Създаване на структурни елементи
AddStructureElement създава речник /StructElem и го добавя като дъщерен елемент на Parent; подайте nil, за да го свържете под корена на дървото на структурата. PageIndex свързва елемента със страницата чрез /Pg, а отрицателна стойност пропуска тази връзка. MCID, когато е нула или по-голям, свързва marked-content последователност на страницата с елемента и я регистрира в документния /ParentTree. Overload с шест аргумента добавя /Alt за алтернативно описание и /ActualText за заместващ текст при копиране. Overload със седем аргумента записва и уникален за документа /ID
Стандартни типове структура (Table 333)
Overload с THPDFStandardStructureType е type-safe входната точка: записаната роля /S винаги е един от стандартните типове структура от ISO 32000-1 §14.8.4 Table 333, което намалява риска от правописни грешки или различен регистър в свободен текстов role
- Групиране:
sstDocument,sstPart,sstArt,sstSect,sstDiv,sstBlockQuote,sstCaption,sstTOC,sstTOCI,sstIndex,sstNonStruct,sstPrivate - Блоково ниво:
sstH,sstH1-sstH6,sstP,sstL,sstLI,sstLbl,sstLBody,sstTable,sstTR,sstTH,sstTD,sstTHead,sstTBody,sstTFoot - Inline ниво:
sstSpan,sstQuote,sstNote,sstReference,sstBibEntry,sstCode,sstLink,sstAnnot - Ruby и Warichu:
sstRuby,sstRB,sstRT,sstRP,sstWarichu,sstWT,sstWP - Илюстрация:
sstFigure,sstFormula,sstForm
Обърнете внимание на малките букви в sstLbl / sstLBody: действителните имена на PDF роли са Lbl и LBody. Персонализирани имена на роли все още могат да се подават чрез overload с AnsiString и да се съпоставят обратно към стандартна роля чрез AddStructRoleMap
Пример
PDF.PDFUACompliance := pdfuaPDFUA1;
PDF.BeginDoc;
Doc := PDF.AddStructureElement(sstDocument, nil);
H1 := PDF.AddStructureElement(sstH1, Doc);
PDF.SetStructureElementLanguage(Doc, 'en-US');
PDF.SetStructureElementTitle(H1, 'Annual Report');
// Alt / ActualText ride on the AnsiString overload; reuse the
// spec-prescribed role name via StandardStructureTypeToName
Fig := PDF.AddStructureElement(StandardStructureTypeToName(sstFigure), Doc, 0, -1,
'Sales by quarter: Q1 4.2M, Q2 5.1M, Q3 5.8M, Q4 6.4M', '');Атрибути на структурата и съпоставяне на роли
SetStructureElementLanguage записва BCP-47 override за /Lang, SetStructureElementExpansionText записва разширителен текст /E, SetStructureElementTitle записва четимото заглавие /T, а AddStructRoleMap съпоставя персонализирани структурни роли обратно към стандартни PDF роли. StandardStructureTypeToName връща името на PDF ролята за стойност THPDFStandardStructureType, а IsStandardStructureType проверява дали името на роля е стандартно
Помощни функции от високо ниво за tagged съдържание
EmitTaggedHeading, BeginTaggedList, EmitTaggedListItem, BeginTaggedTable, AddTaggedTableRow, EmitTaggedTableHeader, EmitTaggedTableCell, BeginTaggedFigure, EndTaggedFigure и RegisterAnnotForStructure покриват обичайното PDF/UA свързване на заглавия, списъци, таблици, фигури и анотации, без извикващият код да управлява MCID ръчно
Типичен работен поток
Активирайте tagged изход или PDFUACompliance, създайте кореновия структурен елемент, използвайте помощните функции за семантично съдържание и затворете всяка започната tagged-content или figure последователност преди EndDoc