Bookmark - TPdf - PDFium Delphi Component

Component: TPdf · Unit: PDFium

Slår upp ett bokmärke efter dess titelssträng och returnerar den matchande TBookmark-posten från dokumentets dispositions-träd som definieras i PDF-avsnitt 12.3.3

Syntax

property Bookmark[const Title: WString]: TBookmark; // read only

Description

PDF-dispositionen (även kallad dokumentdisposition eller "bokmärken" i visare som Acrobat) är ett hierarkiskt träd av namngivna poster som användaren navigerar från sidopanelen. Varje post har en titel, en valfri destination eller åtgärd samt noll eller fler barn. PDFium Delphi Component plattar ut trädet till en sekvens av TBookmark-poster som behåller det underliggande FPDF_BOOKMARK-handtaget plus förhandsupplöst titel, målsidnummer, åtgärdstyp och åtgärdsmål

Strängindexerade formen Bookmark utför en skiftlägeskänslig sökning genom hela dispositionsträdet (djupet först) och returnerar den första matchande noden. Den returnerade posten har Handle = nil och PageNumber = 0 när ingen post med den titeln finns — kontrollera Handle innan du navigerar

Använd Bookmarks för att räkna upp varje nod i dokumentordning, BookmarkChildren för att gå en nivå av nästling, och BookmarkFrom för att konvertera ett rått handtag (till exempel från en klickhändelse i visaren) tillbaka till en ifylld post

Parameters

Title

WString. Den fullständiga bokmärkestiteln att matcha. Jämförelsen är skiftlägeskänslig och exakt (ingen delsträngs- eller jokerteckenmatchning). Blanksteg och skiljetecken i titeln måste återges exakt som de lagras i PDF-dispositionen

Remarks

Fältet Action i den returnerade posten anger hur bokmärket beter sig vid aktivering — acGoto hoppar till ActionPageNumber inne i dokumentet, acGotoRemote riktar mot en annan PDF-fil, acUri öppnar en URL, acLaunch kör en extern fil och acUnsupported betyder att PDFium inte kunde tolka destinationen
Två dispositionsposter kan legitimt dela samma titel (till exempel "Introduction" som förekommer i flera kapitel). Denna indexerare returnerar alltid den första träffen i djupet-först-ordning; använd Bookmarks om du behöver alla matchningar
Bokmärkes sidnummer är ettbaserade; en destination som inte kunde lösas upp rapporteras som 0

Example

var
  Bm: TBookmark;
begin
  Pdf1.LoadFromFile('specification.pdf');
  Bm := Pdf1.Bookmark['Chapter 5: Annotations'];
  if Bm.Handle <> nil then
  begin
    case Bm.Action of
      acGoto:     Pdf1.PageNumber := Bm.ActionPageNumber;
      acUri:      ShowMessage('URL bookmark');
      acGotoRemote: ShowMessage('External PDF target');
    end;
  end
  else
    ShowMessage('No bookmark with that title.');
end;

Bookmark Egenskap