BeginTagEx2

PDF gắn thẻ và khả năng truy cập

Mô tả

Mở một structure element mới và đẩy nó lên tag stack, đặt mọi thuộc tính chính của phần tử trong một lần gọi. BeginTagEx2 là wrapper tiện lợi cho BeginTagEx theo sau bởi SetStructElemTitle, SetStructElemID và SetStructElemExpansion. Truyền chuỗi rỗng cho bất kỳ Title, ElemID hay Expansion nào sẽ bỏ qua setter tương ứng; các tham số còn lại hành vi giống hệt BeginTagEx

Dùng BeginTagEx2 khi bạn đã biết toàn bộ thuộc tính mô tả của phần tử ngay lúc mở nó, để tránh gọi nhiều setter liên tiếp. Nếu có thuộc tính xác định về sau (ví dụ AltText đến không đồng bộ), dùng BeginTag hoặc BeginTagEx rồi gọi các setter riêng lẻ sau đó

Cú pháp

Delphi

Function TPDFlib.BeginTagEx2(Const TagType, AltText, ActualText, Lang, Title, ElemID, Expansion: WideString): Integer;

ActiveX

Function PDFlib::BeginTagEx2(TagType As String, AltText As String, ActualText As String, Lang As String, Title As String, ElemID As String, Expansion As String) As Long

DLL

int DLBeginTagEx2(int InstanceID, const wchar_t * TagType, const wchar_t * AltText, const wchar_t * ActualText, const wchar_t * Lang, const wchar_t * Title, const wchar_t * ElemID, const wchar_t * Expansion);

Tham số

TagTypeTên kiểu structure element, vd. Figure, Table, Span, P. Cùng các kiểu mà BeginTag chấp nhận
AltTextVăn bản thay thế ghi vào mục /Alt (ISO 32000-1 §14.9.3). Truyền chuỗi rỗng để bỏ qua.
ActualTextVăn bản thực tế ghi vào mục /ActualText (ISO 32000-1 §14.9.4). Truyền chuỗi rỗng để bỏ qua.
LangThẻ ngôn ngữ BCP 47 ghi vào mục /Lang (ISO 32000-1 §14.9.2), ví dụ en-US, fr, zh-Hant-TW. Truyền chuỗi rỗng để kế thừa ngôn ngữ tài liệu.
TitleNhãn dễ đọc ghi vào mục /T (ISO 32000-1 §14.7.2). Hiển thị trong bảng điều hướng Tags. Truyền chuỗi rỗng để bỏ qua.
ElemIDĐịnh danh phần tử duy nhất ghi vào mục /ID (ISO 32000-1 §14.7.4). Nếu đặt, phải duy nhất trong tài liệu. Truyền chuỗi rỗng để bỏ qua.
ExpansionDạng viết đầy đủ của từ viết tắt hoặc acronym ghi vào mục /E (ISO 32000-1 §14.9.5). Truyền chuỗi rỗng để bỏ qua.

Giá trị trả về

Trả về 1 khi thành công, 0 nếu chưa chọn tài liệu nào.

Ghi chú

Gọi EndTag một lần cho mỗi lần gọi BeginTagEx2 thành công để pop phần tử khỏi tag stack. Structure element có thể lồng nhau: gọi BeginTagEx2 khi vẫn còn phần tử đang mở sẽ tạo ra một phần tử con

Cài đặt nội bộ hoàn toàn tương đương với:

BeginTagEx(TagType, AltText, ActualText, Lang);
if Title <> '' then SetStructElemTitle(Title);
if ElemID <> '' then SetStructElemID(ElemID);
if Expansion <> '' then SetStructElemExpansion(Expansion);

Các setter riêng lẻ vẫn còn dùng được cho những thuộc tính được xác định sau khi phần tử đã mở, hoặc cho thuộc tính mà BeginTagEx2 không phủ (như AddTagAttribute cho attribute ô bảng)

Ví dụ

// Tag a figure with all descriptive properties in one call
PDFlib.BeginTagEx2(
  'Figure',                              // TagType
  'Bar chart: Q1 120, Q2 145, Q3 98',   // AltText
  '',                                    // ActualText (not needed for images)
  '',                                    // Lang (inherit document language)
  'Figure 3: Quarterly Sales',           // Title
  'fig-quarterly-sales',                 // ElemID
  ''                                     // Expansion (not an abbreviation)
);
PDFlib.SetStructElemBBox(x, y, x + w, y + h);
PDFlib.DrawImage(imgHandle, x, y, w, h);
PDFlib.EndTag;

// Tag an acronym span with its expansion
PDFlib.BeginTagEx2(
  'Span',
  '',                                          // AltText
  '',                                          // ActualText
  '',                                          // Lang
  '',                                          // Title
  '',                                          // ElemID
  'World Wide Web Consortium'                  // Expansion
);
PDFlib.WriteText('W3C');
PDFlib.EndTag;

Xem thêm

BeginTag, BeginTagEx, EndTag, SetStructElemTitle, SetStructElemID, SetStructElemExpansion