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 документа. Перевантаження з шістьма аргументами додає /Alt і /ActualText, а перевантаження з сімома аргументами також записує унікальний для документа /ID

Стандартні типи структури (Table 333)

Перевантаження THPDFStandardStructureType є типобезпечним входом: записане ім’я ролі /S гарантовано належить до стандартних типів структури ISO 32000-1 §14.8.4 Table 333, що прибирає ризик помилок у відкритому рядковому імені ролі та залежності від регістру

• Групування: 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
• Вбудований рівень: 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. Власні імена ролей усе ще можна передати через перевантаження 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 записує перевизначення /Lang у форматі BCP-47, 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 або фігури перед EndDoc