BeginArtifactExA

Tagged PDF, Dostępność

Opis

Końcowa litera A oznacza punkt wejścia DLL ANSI (char); powierzchnia ActiveX/COM udostępnia wyłącznie postać Unicode. Zachowanie jest identyczne jak w BeginArtifactEx, a argumenty ciągów są interpretowane przy użyciu bieżącej strony kodowej SetAnsiMode

Otwiera sekwencję oznaczonej zawartości artefaktu PDF z jawnym typem artefaktu i opcjonalnym podtypem Pagination w jednym wywołaniu. Rozszerza funkcję BeginArtifact o obsługę pełnego słownika właściwości artefaktu zdefiniowanego w ISO 32000-1 §14.8.2.2.1 Table 330.

Użyj tej funkcji, gdy w jednym operatorze trzeba określić zarówno typ artefaktu (Pagination, Layout lub Page), jak i podtyp Pagination (Header, Footer, Watermark, PageNum lub LineNum). Jeśli potrzebny jest tylko jeden z tych wymiarów, wystarczy funkcja BeginArtifact.

Po każdym wywołaniu BeginArtifactEx musi nastąpić odpowiadające mu wywołanie EndArtifact

Składnia

Delphi

Function DLBeginArtifactExA(InstanceID: Integer; ArtifactType, ArtifactSubtype: PAnsiChar): Integer;

DLL

int DLBeginArtifactExA(int InstanceID, const char * ArtifactType, const char * ArtifactSubtype);

Parametry

ArtifactTypeNazwa typu artefaktu zapisywana jako właściwość /Type. Prawidłowe wartości według ISO 32000-1 §14.8.2.2.1:
  • Pagination — nagłówek lub stopka strony, numer strony albo inny element paginacji
  • Layout — zawartość wynikająca z układu, na przykład linie między kolumnami lub dekoracja tła
  • Page — zawartość właściwa stronie, niezwiązana z żadną strukturą logiczną
Przekaż pusty ciąg, aby pominąć /Type (operator użyje tylko /Subtype albo samego /Artifact BMC).
ArtifactSubtypePodtyp Pagination zapisywany jako właściwość /Subtype. Ma znaczenie tylko wtedy, gdy ArtifactType ma wartość Pagination. Typowe wartości: Header, Footer, Watermark, PageNum, LineNum. Przekaż pusty ciąg, aby pominąć /Subtype.

Zapis operatora

Obie wartości niepuste/Artifact << /Type /T /Subtype /S >> BMC
Tylko typ/Artifact << /Type /T >> BMC
Tylko podtyp/Artifact << /Subtype /S >> BMC
Obie wartości puste/Artifact BMC

Wartości zwracane

0Niepowodzenie (brak otwartego dokumentu)
1Sekwencja artefaktu została pomyślnie otwarta

Przykład

// Mark a running header as a Pagination artifact with subtype Header
PDF.BeginArtifactEx('Pagination', 'Header');
PDF.PrintText(50, 780, 'Chapter 3  —  Results');
PDF.EndArtifact;

// Mark a column rule as a Layout artifact (no subtype needed)
PDF.BeginArtifactEx('Layout', '');
PDF.DrawLine(300, 50, 300, 750);
PDF.EndArtifact;