THotPDF.AddStructureElement és Tagged PDF segédfüggvények

Ez az oldal a THotPDF aktuális Tagged PDF és PDF/UA struktúrafa segédfüggvényeit dokumentálja. A kódazonosítók megfelelnek a nyilvános deklarációknak

Aktuális Delphi felület

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;

Struktúraelemek létrehozása

Az AddStructureElement létrehoz egy /StructElem szótárat, és a Parent gyermekeként csatolja; nil esetén a struktúrafa gyökere alá kerül. A PageIndex a /Pg bejegyzésen keresztül kapcsolja az elemet az oldalhoz, negatív érték pedig kihagyja ezt. A nulla vagy nagyobb MCID egy oldalon lévő marked-content szekvenciát köt az elemhez, és regisztrálja a dokumentum /ParentTree fájában. A hatargumentumos overload /Alt és /ActualText értéket ad hozzá, a hétargumentumos overload pedig dokumentumszinten egyedi /ID értéket is ír

Standard struktúratípusok (Table 333)

A THPDFStandardStructureType enum overload a típust biztosító belépési pont: a kibocsátott /S szerepnév garantáltan az ISO 32000-1 §14.8.4 Table 333 standard struktúratípusai közül kerül ki, így elkerülhetők a szabad szöveges szerepnevek elírásai és kis/nagybetűs hibái

• Csoportosítás: sstDocument, sstPart, sstArt, sstSect, sstDiv, sstBlockQuote, sstCaption, sstTOC, sstTOCI, sstIndex, sstNonStruct, sstPrivate
• Blokkszint: sstH, sstH1-sstH6, sstP, sstL, sstLI, sstLbl, sstLBody, sstTable, sstTR, sstTH, sstTD, sstTHead, sstTBody, sstTFoot
• Soron belüli szint: sstSpan, sstQuote, sstNote, sstReference, sstBibEntry, sstCode, sstLink, sstAnnot
• Ruby és Warichu: sstRuby, sstRB, sstRT, sstRP, sstWarichu, sstWT, sstWP
• Illusztráció: sstFigure, sstFormula, sstForm

Figyelje meg a kisbetűket az sstLbl / sstLBody nevekben: a tényleges PDF szerepnevek Lbl és LBody. Egyedi szerepnevek továbbra is átadhatók az AnsiString overloadon keresztül, majd AddStructRoleMap segítségével standard szerepre képezhetők le

Példa

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

Struktúraattribútumok és szerepleképezés

A SetStructureElementLanguage BCP-47 szerinti /Lang felülírást ír, a SetStructureElementExpansionText az /E kiegészítő szöveget írja, a SetStructureElementTitle az ember által olvasható /T címet rögzíti, az AddStructRoleMap pedig egyedi struktúraszerepeket képez vissza standard PDF-szerepekre. A StandardStructureTypeToName PDF szerepnevet ad vissza egy THPDFStandardStructureType értékhez, az IsStandardStructureType pedig ellenőrzi, hogy egy szerepnév standard-e

Magas szintű segédfüggvények tagged tartalomhoz

Az EmitTaggedHeading, BeginTaggedList, EmitTaggedListItem, BeginTaggedTable, AddTaggedTableRow, EmitTaggedTableHeader, EmitTaggedTableCell, BeginTaggedFigure, EndTaggedFigure és RegisterAnnotForStructure lefedik a PDF/UA címsorok, listák, táblák, ábrák és annotációk szokásos bekötését anélkül, hogy a hívónak kézzel kellene MCID értékeket kezelnie

Tipikus munkafolyamat

Kapcsolja be a tagged kimenetet vagy a PDFUACompliance beállítást, hozza létre a gyökér struktúraelemet, a segédfüggvényekkel bocsásson ki szemantikus tartalmat, és zárjon le minden megkezdett tagged-content vagy ábra szekvenciát az EndDoc előtt