THotPDF.AddStructureElement og hjelpere for Tagged PDF

Denne siden dokumenterer gjeldende THotPDF-hjelpere for Tagged PDF og PDF/UA-strukturtrær. Kodeidentifikatorer samsvarer med de offentlige deklarasjonene

Gjeldende Delphi-flate

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;

Opprette strukturelementer

AddStructureElement oppretter en /StructElem-ordbok og legger den til som barn av Parent; bruk nil for å feste den under roten i strukturtreet. PageIndex kobler elementet til siden via /Pg, mens en negativ verdi utelater koblingen. MCID fra null og oppover knytter en marked-content-sekvens på siden til elementet og registrerer den i dokumentets /ParentTree. Overloaden med seks argumenter legger til /Alt og /ActualText, og overloaden med sju argumenter skriver også en dokumentunik /ID

Standard strukturtyper (Table 333)

Overloaden med THPDFStandardStructureType er et typesikkert inngangspunkt: rollenavnet /S som skrives ut, er garantert en standard strukturtype fra ISO 32000-1 §14.8.4 Table 333, noe som fjerner faren for skrivefeil og store/små bokstaver i en åpen tekstrolle

• Gruppering: sstDocument, sstPart, sstArt, sstSect, sstDiv, sstBlockQuote, sstCaption, sstTOC, sstTOCI, sstIndex, sstNonStruct, sstPrivate
• Blokknivå: sstH, sstH1-sstH6, sstP, sstL, sstLI, sstLbl, sstLBody, sstTable, sstTR, sstTH, sstTD, sstTHead, sstTBody, sstTFoot
• Innebygd nivå: sstSpan, sstQuote, sstNote, sstReference, sstBibEntry, sstCode, sstLink, sstAnnot
• Ruby og Warichu: sstRuby, sstRB, sstRT, sstRP, sstWarichu, sstWT, sstWP
• Illustrasjon: sstFigure, sstFormula, sstForm

Legg merke til små bokstaver i sstLbl / sstLBody: de faktiske PDF-rollenavnene er Lbl og LBody. Egendefinerte rollenavn kan fortsatt sendes gjennom AnsiString-overloaden og mappes tilbake til en standardrolle med AddStructRoleMap

Eksempel

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', '');

Strukturattributter og rollekartlegging

SetStructureElementLanguage skriver en BCP-47 /Lang-overstyring, SetStructureElementExpansionText skriver utvidelsesteksten /E, SetStructureElementTitle skriver den lesbare tittelen /T, og AddStructRoleMap mapper egendefinerte strukturroller tilbake til standard PDF-roller. StandardStructureTypeToName returnerer PDF-rollenavnet for en THPDFStandardStructureType-verdi, og IsStandardStructureType kontrollerer om et rollenavn er standard

Høynivåhjelpere for tagged innhold

EmitTaggedHeading, BeginTaggedList, EmitTaggedListItem, BeginTaggedTable, AddTaggedTableRow, EmitTaggedTableHeader, EmitTaggedTableCell, BeginTaggedFigure, EndTaggedFigure og RegisterAnnotForStructure dekker vanlig PDF/UA-kobling for overskrifter, lister, tabeller, figurer og annotasjoner uten at kalleren må håndtere MCID manuelt

Typisk arbeidsflyt

Aktiver tagged output eller PDFUACompliance, opprett rotstrukturelementet, bruk hjelperfamilien til å skrive semantisk innhold, og lukk alle startede tagged-content- eller figursekvenser før EndDoc