THotPDF.AddStructureElement e auxiliares de Tagged PDF
Esta página documenta os auxiliares actuais de THotPDF para Tagged PDF e árvores de estrutura PDF/UA. Os identificadores de código correspondem às declarações públicas
Interface Delphi actual
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;Criar elementos de estrutura
AddStructureElement cria um dicionário /StructElem e adiciona-o como filho de Parent; passe nil para o ligar abaixo da raiz da árvore de estrutura. PageIndex associa o elemento à página através de /Pg, enquanto um valor negativo omite essa ligação. MCID, quando é zero ou superior, associa uma sequência marked-content na página ao elemento e regista-a no /ParentTree do documento. O overload de seis argumentos adiciona /Alt para descrição alternativa e /ActualText para texto de substituição ao copiar. O overload de sete argumentos também escreve um /ID único no documento
Tipos de estrutura standard (Table 333)
O overload com THPDFStandardStructureType é o ponto de entrada type-safe: a role /S escrita pertence sempre aos tipos de estrutura standard de ISO 32000-1 §14.8.4 Table 333, reduzindo o risco de gralhas ou diferenças de maiúsculas e minúsculas numa role em texto livre
- Agrupamento:
sstDocument,sstPart,sstArt,sstSect,sstDiv,sstBlockQuote,sstCaption,sstTOC,sstTOCI,sstIndex,sstNonStruct,sstPrivate - Nível de bloco:
sstH,sstH1-sstH6,sstP,sstL,sstLI,sstLbl,sstLBody,sstTable,sstTR,sstTH,sstTD,sstTHead,sstTBody,sstTFoot - Nível inline:
sstSpan,sstQuote,sstNote,sstReference,sstBibEntry,sstCode,sstLink,sstAnnot - Ruby e Warichu:
sstRuby,sstRB,sstRT,sstRP,sstWarichu,sstWT,sstWP - Ilustração:
sstFigure,sstFormula,sstForm
Repare nas minúsculas em sstLbl / sstLBody: os nomes reais das roles PDF são Lbl e LBody. Nomes de roles personalizados continuam a poder ser passados pelo overload AnsiString e mapeados de volta para uma role standard com AddStructRoleMap
Exemplo
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', '');Atributos de estrutura e mapeamento de roles
SetStructureElementLanguage escreve uma substituição BCP-47 para /Lang, SetStructureElementExpansionText escreve o texto de expansão /E, SetStructureElementTitle escreve o título legível /T, e AddStructRoleMap mapeia roles de estrutura personalizadas de volta para roles PDF standard. StandardStructureTypeToName devolve o nome da role PDF para um valor THPDFStandardStructureType, e IsStandardStructureType verifica se um nome de role é standard
Auxiliares de alto nível para conteúdo tagged
EmitTaggedHeading, BeginTaggedList, EmitTaggedListItem, BeginTaggedTable, AddTaggedTableRow, EmitTaggedTableHeader, EmitTaggedTableCell, BeginTaggedFigure, EndTaggedFigure e RegisterAnnotForStructure cobrem a ligação PDF/UA habitual para títulos, listas, tabelas, figuras e anotações sem exigir gestão manual de MCID
Fluxo de trabalho típico
Active a saída tagged ou PDFUACompliance, crie o elemento de estrutura raiz, use a família de auxiliares para conteúdo semântico e feche cada sequência tagged-content ou figure iniciada antes de EndDoc