SetStructElemAltTextA

PDF برچسب‌گذاری‌شده و دسترس‌پذیری

توضیحات

حرف A انتهایی نشان‌دهنده نقطه ورودی ANSI (char) در DLL است؛ رابط ActiveX/COM تنها فرم Unicode را نشان می‌دهد. رفتار آن با SetStructElemAltText یکسان است و آرگومان‌های رشته‌ای با استفاده از صفحه کد فعلی SetAnsiMode تفسیر می‌شوند

Sets the /Alt entry on the structure element currently being built on the tag stack. Alternative text is the text description that assistive technology (screen readers, braille displays) presents to users when the element cannot be rendered visually — for example, an image, figure, or mathematical formula.

این تابع معادل پاس دادن آرگومان AltText غیریختی به BeginTag یا BeginTagEx است، اما اجازه می‌دهد متن جایگزین پس از باز شدن عنصر تنظیم یا به‌روزرسانی شود. وقتی توصیف پس از شناخته شدن نوع عنصر به‌صورت غیرهمگام محاسبه یا بازیابی می‌شود کاربرد دارد

نحو

Delphi

Function DLSetStructElemAltTextA(InstanceID: Integer; AltText: PAnsiChar): Integer;

DLL

int DLSetStructElemAltTextA(int InstanceID, const char * AltText);

پارامترها

AltTextتوصیف متن جایگزین برای مرتبط‌کردن با عنصر ساختاری جاری؛ برای پاک کردن مقدار قبلاً تنظیم‌شده رشتهٔ خالی بدهید

مقدار بازگشتی

در صورت موفقیت 1 برمی‌گرداند؛ اگر در حال حاضر هیچ عنصر ساختاری بازی باز نباشد یا سندی انتخاب نشده باشد 0

ملاحظات

این تابع را بلافاصله بعد از BeginTag وقتی عنصر هدف بالای پشتهٔ تگ است، یا هر زمانی پیش از فراخوانی EndTag متناظر فراخوانی کنید

AltText و ActualText هدف‌های متفاوتی دارند. AltText جایگزین متنی کاملی برای کل عنصر است — محتوای دیداری را برای کاربرانی جایگزین می‌کند که نمی‌توانند خروجی رندرشده را درک کنند. ActualText (ISO 32000-1 §14.9.4) توالی دقیق نویسه‌های Unicode را برای glyphهای inline فراهم می‌کند؛ glyphهایی که در غیر این صورت متن استخراج‌شده‌شان نادرست می‌بود (مثلاً ligatureها)، و rendering را جایگزین نمی‌کند. Screen readerها معمولاً برای عنصرهای Figure و Formula، AltText را می‌خوانند و برای اصلاح‌های سطح نویسه از ActualText استفاده می‌کنند

ISO 32000-1 §14.9.3 ورودی /Alt را تعریف می‌کند. PDF/UA-1 (ISO 14289-1 §7.5) توضیحات جایگزین را برای عناصر ساختاری Figure و Formula لازم می‌داند. GetPDFUADiagnostics در صورت نبودن متن Alt برای عناصر Figure یا Formula، کد مشکل FIGURE-NO-ALT:N را گزارش می‌کند.

مثال

// Tag an embedded chart image with alternative text
PDFlib.BeginTag('Figure', '', '');
PDFlib.SetStructElemAltText('Bar chart: Q1 sales 120, Q2 sales 145, Q3 sales 98');
PDFlib.SetStructElemBBox(x, y, x + w, y + h);
PDFlib.DrawImage(imgHandle, x, y, w, h);
PDFlib.EndTag;

همچنین ببینید

BeginTag, BeginTagEx, SetStructElemActualText, SetStructElemLang, GetPDFUADiagnostics