AddTagAttribute

Tagged PDF, Tilgængelighed

Beskrivelse

Tilføjer en navngivet attribut til det strukturelement, der aktuelt opbygges på tagstakken. Attributten skrives som en PDF-/A-attributordbog (eller et array af ordbøger), når dokumentet gemmes. Kald dette efter BeginTag eller BeginTagEx og før EndTag.

Syntaks

Delphi

Function TPDFlib.AddTagAttribute(Const Owner, Name, Value: WideString): Integer;

ActiveX

Function PDFlib::AddTagAttribute(Owner As String, Name As String, Value As String) As Long

DLL

int DLAddTagAttribute(int InstanceID, const wchar_t * Owner, const wchar_t * Name, const wchar_t * Value);

Parametre

Owner	Navnet på attributindehaveren som defineret i ISO 32000-1 Table 348 (f.eks. `Layout`, `Table`, `List`, `PrintField`). Dette bliver nøglen `/O` i attributordbogen.
Name	Attributnavnet for den angivne ejer (f.eks. `BBox` for Layout og `Scope` for Table). Må ikke være tomt.
Value	Attributværdien som en streng. Værdier, der kun indeholder tal adskilt af mellemrum (f.eks. `"0 0 200 100"`), skrives som et PDF-array af reelle tal. Enhver anden værdi skrives som et PDF-navneobjekt (uden et indledende `/`). Må ikke være tom.

Returværdi

Returnerer 1 ved succes. Returnerer 0, hvis intet dokument er åbent, intet tag er åbent i øjeblikket, eller Owner eller Name er tom.

Bemærkninger

Flere kald til AddTagAttribute for det samme åbne tag akkumuleres. Når attributter tilhører én ejer, skriver biblioteket én /A-attributordbog. Når flere ejere bruges, grupperes attributterne pr. ejer og skrives som et array af attributordbøger.

For almindelige attributter kan bekvemmeligheds-wrapperne SetStructElemScope og SetStructElemBBox bruges i stedet for at kalde AddTagAttribute direkte.

Attributter nulstilles, når et nyt tag åbnes; de nedarves ikke af underordnede elementer

Eksempel

// Mark a table header cell with column scope
PDFlib.BeginTag('TH', '', '', '');
PDFlib.AddTagAttribute('Table', 'Scope', 'Column');
// ... draw cell content
PDFlib.EndTag;

// Mark a figure with a bounding box
PDFlib.BeginTag('Figure', 'Company logo', '', '');
PDFlib.AddTagAttribute('Layout', 'BBox', '72 600 200 700');
PDFlib.EndTag;

Se også

BeginTag, BeginTagEx, EndTag, SetStructElemScope, SetStructElemBBox