SetStructElemListNumbering

Getagde PDF, toegankelijkheid

Beschrijving

Zet het attribuut /ListNumbering (List-attribuuteigenaar) op het structuurelement dat momenteel open staat op de tagstack. De waarde verklaart het markerings- of nummeringsschema dat voor items in een L (list)-structuurelement wordt gebruikt, zodat hulptechnologie het lijsttype correct kan aankondigen. Gelijk aan het aanroepen van AddTagAttribute met Owner=List, Name=ListNumbering en de schemanaam als waarde

Syntaxis

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

Parameters

NumberingHet nummeringsschema van de lijst. Dit moet een van de volgende hoofdlettergevoelige waarden zijn:

None — geen zichtbaar markeringsteken (standaard wanneer het attribuut ontbreekt)
Disc — gevulde cirkel (•)
Circle — open cirkel (○)
Square — gevuld vierkant (■)
Decimal — 1, 2, 3 …
UpperRoman — I, II, III …
LowerRoman — i, ii, iii …
UpperAlpha — A, B, C …
LowerAlpha — a, b, c …

Retourwaarde

Retourneert 1 bij succes. Retourneert 0 als er geen document is geopend of momenteel geen tag op de tagstack geopend is

Opmerkingen

Roep deze functie aan na BeginTag met tagtype L (list) en vóór EndTag. Het attribuut /ListNumbering is gedefinieerd in ISO 32000-1 §14.8.5.3.2 (List-attribuuteigenaar, Table 336)

Het attribuut geldt voor het omvattende L-element, niet voor afzonderlijke LI-items. Zet het één keer op het L-element direct na het openen. Het attribuut is adviserend: het vertelt hulptechnologie wat voor lijst dit is, zodat die "bullet list", "numbered list" enzovoort kan aankondigen — ongeacht welke visuele markeringglyphs de PDF-renderer feitelijk heeft getekend

Heeft een lijst geen expliciet nummeringssysteem (bijvoorbeeld een reeks termen zonder zichtbare opsommingstekens), gebruik dan None of laat het attribuut helemaal weg

Voorbeeld

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

Zie ook

SetStructElemExpansion, AddTagAttribute, BeginTag, EndTag, GetPDFUADiagnostics