SetStructElemListNumbering

Tagged PDF, Tilgængelighed

Beskrivelse

Indstiller attributten /ListNumbering (ejeren List-attribut) på det strukturelement, der aktuelt er åbent på tagstakken. Værdien erklærer den markør eller nummereringsordning, der bruges til elementer i et L-strukturelement (liste), så hjælpeteknologi kan annoncere listetypen korrekt. Svarer til at kalde AddTagAttribute med Owner=List, Name=ListNumbering og ordningens navn som værdi.

Syntaks

Delphi

Function TPDFlib.SetStructElemListNumbering(Const Numbering: WideString): Integer;

ActiveX

Function PDFlib::SetStructElemListNumbering(Numbering As String) As Long

DLL

int DLSetStructElemListNumbering(int InstanceID, const wchar_t * Numbering);

Parametre

NumberingListenummereringsskemaet. Skal være en af følgende værdier (med skelnen mellem store og små bogstaver):

None — ingen synlig markør (standard, når attributten mangler)
Disc — udfyldt cirkel (•)
Circle — åben cirkel (○)
Square — udfyldt firkant (■)
Decimal — 1, 2, 3 …
UpperRoman — I, II, III …
LowerRoman — i, ii, iii …
UpperAlpha — A, B, C …
LowerAlpha — a, b, c …

Returværdi

Returnerer 1 ved succes. Returnerer 0, hvis intet dokument er åbent, eller intet tag aktuelt er åbent på tagstakken

Bemærkninger

Kald denne funktion efter BeginTag med tagtypen L (liste) og før EndTag. Attributten /ListNumbering er defineret i ISO 32000-1 §14.8.5.3.2 (List-attributindehaver, Table 336).

Attributten gælder for det omsluttende L-element, ikke for de enkelte LI-elementer. Indstil den én gang på L-elementet umiddelbart efter åbningen. Attributten er vejledende: Den fortæller hjælpeteknologi, hvilken type liste dette er, så den kan annoncere "punktliste", "nummereret liste" og så videre — uanset hvilke visuelle markørglyffer PDF-gengiveren faktisk tegnede

Når en liste ikke har noget eksplicit nummereringssystem (f.eks. en række termer uden synlige punkttegn), skal du bruge None eller helt udelade attributten.

Eksempel

// An ordered decimal list
PDFlib.BeginTag('L', '', '', '');
PDFlib.SetStructElemListNumbering('Decimal');

  PDFlib.BeginTag('LI', '', '', '');
    PDFlib.BeginTag('Lbl', '', '', '');
    PDFlib.DrawText('1.', 72, 700);
    PDFlib.EndTag;
    PDFlib.BeginTag('LBody', '', '', '');
    PDFlib.DrawText('First item', 90, 700);
    PDFlib.EndTag;
  PDFlib.EndTag;

  PDFlib.BeginTag('LI', '', '', '');
    PDFlib.BeginTag('Lbl', '', '', '');
    PDFlib.DrawText('2.', 72, 680);
    PDFlib.EndTag;
    PDFlib.BeginTag('LBody', '', '', '');
    PDFlib.DrawText('Second item', 90, 680);
    PDFlib.EndTag;
  PDFlib.EndTag;

PDFlib.EndTag; // L

Se også

SetStructElemExpansion, AddTagAttribute, BeginTag, EndTag, GetPDFUADiagnostics