AddTagAttribute

Getagde PDF, toegankelijkheid

Beschrijving

Voegt een benoemd attribuut toe aan het structuurelement dat momenteel op de tagstack wordt opgebouwd. Het attribuut wordt bij het opslaan van het document weggeschreven als PDF /A-attribuutwoordenboek (of array van woordenboeken). Roep dit aan na BeginTag of BeginTagEx en vóór EndTag

Syntaxis

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

Parameters

Owner	De attribuuteigenaarnaam zoals gedefinieerd in ISO 32000-1 Table 348 (bijv. `Layout`, `Table`, `List`, `PrintField`). Dit wordt de `/O`-sleutel in het attribuutwoordenboek
Name	De attribuutnaam voor de opgegeven eigenaar (bijv. `BBox` voor Layout, `Scope` voor Table). Mag niet leeg zijn
Value	De attribuutwaarde als string. Een enkel getal wordt weggeschreven als PDF-getal, en waarden die alleen door spaties gescheiden getallen bevatten (bijv. `"0 0 200 100"`) worden weggeschreven als PDF-array van reële getallen. Getallen gebruiken op elk systeem een punt als decimaalteken; een getal dat met het eigen decimaalteken van het systeem is geschreven wordt ook geaccepteerd. Elke andere waarde wordt weggeschreven als PDF name-object (zonder voorloop `/`). Mag niet leeg zijn

Retourwaarde

Geeft bij succes 1 terug. Geeft 0 terug als er geen document is geopend, momenteel geen tag open is, of Owner of Name leeg is

Opmerkingen

Meerdere aanroepen van AddTagAttribute voor dezelfde open tag worden opgeteld. Horen attributen bij één eigenaar, dan schrijft de library één /A-attribuutwoordenboek. Bij meerdere eigenaren worden de attributen per eigenaar gegroepeerd en weggeschreven als array van attribuutwoordenboeken

Voor gangbare attributen kunnen de handige wrappers SetStructElemScope en SetStructElemBBox worden gebruikt in plaats van direct AddTagAttribute aan te roepen

Attributen worden gereset wanneer een nieuwe tag wordt geopend; ze worden niet overgeërfd door kindelementen

Voorbeeld

// 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;

Zie ook

BeginTag, BeginTagEx, EndTag, SetStructElemScope, SetStructElemBBox