API Reference
PdfTextEncodingDiagnostic
Describes text that cannot be written through the current generated PDF text encoding path.
Inheritance
- Object
- PdfTextEncodingDiagnostic
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Property PdfBytesResult.TextEncodingDiagnostics
- Method PdfDocument.AnalyzeTextEncoding
- Property PdfSaveResult.TextEncodingDiagnostics
- Method PdfTextEncodingDiagnostic.WithFieldName
- Method PdfTextEncodingDiagnostic.WithPageNumber
- Method PdfTextEncodingDiagnostic.WithTableCell
- Property PdfTextFallbackPlan.Diagnostics
- Method PdfTextPreflight.AnalyzeEmbeddedFont
- Method PdfTextPreflight.AnalyzeWinAnsi
Accepted by parameters
Constructors
public PdfTextEncodingDiagnostic(String source, Int32 index, String codePoint, String text, Boolean isControlCharacter) #Creates a text encoding diagnostic.
Parameters
- source System.String
- Caller-provided source label such as a block, field, sheet, slide, or converter area.
- index System.Int32
- UTF-16 index of the unsupported character in the inspected text.
- codePoint System.String
- Unicode code point formatted as U+XXXX or U+XXXXX.
- text System.String
- Unsupported character or surrogate pair text. Control characters are represented as an empty string.
- isControlCharacter System.Boolean
- Whether the unsupported character is a control character.
public PdfTextEncodingDiagnostic(String source, Int32 index, String codePoint, String text, Boolean isControlCharacter, String encoding, String remediation) #Creates a text encoding diagnostic with a custom encoding or font coverage description.
Parameters
- source System.String
- Caller-provided source label such as a block, field, sheet, slide, or converter area.
- index System.Int32
- UTF-16 index of the unsupported character in the inspected text.
- codePoint System.String
- Unicode code point formatted as U+XXXX or U+XXXXX.
- text System.String
- Unsupported character or surrogate pair text. Control characters are represented as an empty string.
- isControlCharacter System.Boolean
- Whether the unsupported character is a control character.
- encoding System.String
- Encoding or font coverage description that rejected the character.
- remediation System.String
- Optional remediation guidance for the caller.
public PdfTextEncodingDiagnostic(String source, Int32 index, String codePoint, String text, Boolean isControlCharacter, String encoding, String remediation, String location) #Creates a text encoding diagnostic with a custom encoding or font coverage description and document location.
Parameters
- source System.String
- Caller-provided source label such as a block, field, sheet, slide, or converter area.
- index System.Int32
- UTF-16 index of the unsupported character in the inspected text.
- codePoint System.String
- Unicode code point formatted as U+XXXX or U+XXXXX.
- text System.String
- Unsupported character or surrogate pair text. Control characters are represented as an empty string.
- isControlCharacter System.Boolean
- Whether the unsupported character is a control character.
- encoding System.String
- Encoding or font coverage description that rejected the character.
- remediation System.String
- Optional remediation guidance for the caller.
- location System.String
- Optional generated document location such as a block, table cell, or canvas item path.
public PdfTextEncodingDiagnostic(String source, Int32 index, String codePoint, String text, Boolean isControlCharacter, String encoding, String remediation, String location, Nullable<Int32> runIndex) #Creates a text encoding diagnostic with a custom encoding or font coverage description, document location, and rich-text run index.
Parameters
- source System.String
- Caller-provided source label such as a block, field, sheet, slide, or converter area.
- index System.Int32
- UTF-16 index of the unsupported character in the inspected text.
- codePoint System.String
- Unicode code point formatted as U+XXXX or U+XXXXX.
- text System.String
- Unsupported character or surrogate pair text. Control characters are represented as an empty string.
- isControlCharacter System.Boolean
- Whether the unsupported character is a control character.
- encoding System.String
- Encoding or font coverage description that rejected the character.
- remediation System.String
- Optional remediation guidance for the caller.
- location System.String
- Optional generated document location such as a block, table cell, or canvas item path.
- runIndex System.Nullable{System.Int32}
- Optional zero-based rich text run index inside the generated document location.
public PdfTextEncodingDiagnostic(String source, Int32 index, String codePoint, String text, Boolean isControlCharacter, String encoding, String remediation, String location, Nullable<Int32> runIndex, Nullable<Int32> pageNumber) #Creates a text encoding diagnostic with a custom encoding or font coverage description, document location, rich-text run index, and generated page number.
Parameters
- source System.String
- Caller-provided source label such as a block, field, sheet, slide, or converter area.
- index System.Int32
- UTF-16 index of the unsupported character in the inspected text.
- codePoint System.String
- Unicode code point formatted as U+XXXX or U+XXXXX.
- text System.String
- Unsupported character or surrogate pair text. Control characters are represented as an empty string.
- isControlCharacter System.Boolean
- Whether the unsupported character is a control character.
- encoding System.String
- Encoding or font coverage description that rejected the character.
- remediation System.String
- Optional remediation guidance for the caller.
- location System.String
- Optional generated document location such as a block, table cell, or canvas item path.
- runIndex System.Nullable{System.Int32}
- Optional zero-based rich text run index inside the generated document location.
- pageNumber System.Nullable{System.Int32}
- Optional one-based generated page number for page-scoped diagnostics.
public PdfTextEncodingDiagnostic(String source, Int32 index, String codePoint, String text, Boolean isControlCharacter, String encoding, String remediation, String location, Nullable<Int32> runIndex, Nullable<Int32> pageNumber, Nullable<Int32> tableRowIndex, Nullable<Int32> tableColumnIndex) #Creates a text encoding diagnostic with generated page and table-cell coordinates.
Parameters
- source System.String
- Caller-provided source label such as a block, field, sheet, slide, or converter area.
- index System.Int32
- UTF-16 index of the unsupported character in the inspected text.
- codePoint System.String
- Unicode code point formatted as U+XXXX or U+XXXXX.
- text System.String
- Unsupported character or surrogate pair text. Control characters are represented as an empty string.
- isControlCharacter System.Boolean
- Whether the unsupported character is a control character.
- encoding System.String
- Encoding or font coverage description that rejected the character.
- remediation System.String
- Optional remediation guidance for the caller.
- location System.String
- Optional generated document location such as a block, table cell, or canvas item path.
- runIndex System.Nullable{System.Int32}
- Optional zero-based rich text run index inside the generated document location.
- pageNumber System.Nullable{System.Int32}
- Optional one-based generated page number for page-scoped diagnostics.
- tableRowIndex System.Nullable{System.Int32}
- Optional zero-based table row index for table-cell diagnostics.
- tableColumnIndex System.Nullable{System.Int32}
- Optional zero-based table column index for table-cell diagnostics.
public PdfTextEncodingDiagnostic(String source, Int32 index, String codePoint, String text, Boolean isControlCharacter, String encoding, String remediation, String location, Nullable<Int32> runIndex, Nullable<Int32> pageNumber, Nullable<Int32> tableRowIndex, Nullable<Int32> tableColumnIndex, String fieldName) #Creates a text encoding diagnostic with generated page, table-cell coordinates, and form field name.
Parameters
- source System.String
- Caller-provided source label such as a block, field, sheet, slide, or converter area.
- index System.Int32
- UTF-16 index of the unsupported character in the inspected text.
- codePoint System.String
- Unicode code point formatted as U+XXXX or U+XXXXX.
- text System.String
- Unsupported character or surrogate pair text. Control characters are represented as an empty string.
- isControlCharacter System.Boolean
- Whether the unsupported character is a control character.
- encoding System.String
- Encoding or font coverage description that rejected the character.
- remediation System.String
- Optional remediation guidance for the caller.
- location System.String
- Optional generated document location such as a block, table cell, or canvas item path.
- runIndex System.Nullable{System.Int32}
- Optional zero-based rich text run index inside the generated document location.
- pageNumber System.Nullable{System.Int32}
- Optional one-based generated page number for page-scoped diagnostics.
- tableRowIndex System.Nullable{System.Int32}
- Optional zero-based table row index for table-cell diagnostics.
- tableColumnIndex System.Nullable{System.Int32}
- Optional zero-based table column index for table-cell diagnostics.
- fieldName System.String
- Optional generated AcroForm field name for form-field diagnostics.
Methods
public PdfConversionWarning ToConversionWarning(String converter = "OfficeIMO.Pdf") #PdfConversionWarningConverts this text diagnostic to the shared conversion warning shape used by PDF adapters.
Parameters
- converter System.String = "OfficeIMO.Pdf"
- Converter or adapter name to place on the warning.
Returns
A shared conversion warning carrying this diagnostic and stable details.
public PdfTextEncodingDiagnostic WithFieldName(String fieldName) #PdfTextEncodingDiagnosticReturns a copy of this diagnostic annotated with a generated AcroForm field name.
Parameters
- fieldName System.String
- Generated field name.
Returns
A diagnostic carrying the same text details and the supplied field name.
public PdfTextEncodingDiagnostic WithPageNumber(Int32 pageNumber) #PdfTextEncodingDiagnosticReturns a copy of this diagnostic annotated with a one-based generated page number.
Parameters
- pageNumber System.Int32
- One-based generated page number.
Returns
A diagnostic carrying the same text details and the supplied page number.
public PdfTextEncodingDiagnostic WithTableCell(Int32 rowIndex, Int32 columnIndex) #PdfTextEncodingDiagnosticReturns a copy of this diagnostic annotated with zero-based table cell coordinates.
Parameters
- rowIndex System.Int32
- Zero-based table row index.
- columnIndex System.Int32
- Zero-based table column index.
Returns
A diagnostic carrying the same text details and the supplied table cell coordinates.
Inherited Methods
Properties
public String Source { get; } #Caller-provided source label such as a block, field, sheet, slide, or converter area.
public Int32 Index { get; } #UTF-16 index of the unsupported character in the inspected text.
public String CodePoint { get; } #Unicode code point formatted as U+XXXX or U+XXXXX.
public String Text { get; } #Unsupported character or surrogate pair text. Control characters are represented as an empty string.
public Boolean IsControlCharacter { get; } #Whether the unsupported character is a control character.
public String Encoding { get; } #Encoding or font coverage description that rejected the character.
public String Remediation { get; } #Optional remediation guidance for the caller.
public String Location { get; } #Optional generated document location such as a block, table cell, or canvas item path.
public Nullable<Int32> RunIndex { get; } #Optional zero-based rich text run index inside the generated document location.
public Nullable<Int32> PageNumber { get; } #Optional one-based generated page number for page-scoped diagnostics.
public Nullable<Int32> TableRowIndex { get; } #Optional zero-based table row index for table-cell diagnostics.
public Nullable<Int32> TableColumnIndex { get; } #Optional zero-based table column index for table-cell diagnostics.
public String FieldName { get; } #Optional generated AcroForm field name for form-field diagnostics.
public String Code { get; } #Stable warning code suitable for shared conversion reports.
public String Message { get; } #Human-readable diagnostic message.