API Reference
PdfEmbeddedFontFallbackSet
Pairs embedded fallback candidates with generated PDF font slots used for rendering planned fallback runs.
Inheritance
- Object
- PdfEmbeddedFontFallbackSet
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
Accepted by parameters
Constructors
public PdfEmbeddedFontFallbackSet(IEnumerable<PdfEmbeddedFontFallbackCandidate> candidates) #Creates a reusable fallback set whose candidates are registered as named embedded families. Named fallback families do not consume the Helvetica, Times, or Courier compatibility slots, so they can coexist with document fonts that already use all three slots.
Parameters
- candidates System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfEmbeddedFontFallbackCandidate}
- Fallback font candidates in priority order. Candidate names must be unique.
public PdfEmbeddedFontFallbackSet(IEnumerable<PdfEmbeddedFontFallbackCandidate> candidates, IEnumerable<PdfStandardFont> fontSlots) #Creates a reusable fallback set from prioritized candidates and matching generated font slots.
Parameters
- candidates System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfEmbeddedFontFallbackCandidate}
- Fallback font candidates in priority order.
- fontSlots System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfStandardFont}
- Generated standard-font family slots ordered the same way as candidates.
Methods
public IReadOnlyList<PdfTextShapingDiagnostic> AnalyzeAdvancedTextLayout(String text, String source = "", PdfTextShapingMode shapingMode = UnicodeScalar) #IReadOnlyList<PdfTextShapingDiagnostic>Finds advanced-layout warnings for text planned against this fallback set, including selected-font OpenType feature gaps.
Parameters
- text System.String
- Text to inspect.
- source System.String = ""
- Optional caller-provided source label such as a block, field, sheet, slide, or converter area.
- shapingMode OfficeIMO.Pdf.PdfTextShapingMode = UnicodeScalar
- Text shaping mode to use when checking fallback font coverage.
Returns
Advanced text layout diagnostics in source order, with duplicate warning families collapsed.
public PdfTextFallbackPlan PlanText(String text, String source) #PdfTextFallbackPlanPlans fallback coverage for text using this set's prioritized candidates.
Parameters
- text System.String
- Text to inspect.
- source System.String
- Optional caller-provided source label such as a block, field, sheet, slide, or converter area.
Returns
A fallback plan with covered text segments and missing-glyph diagnostics.
public PdfTextFallbackPlan PlanText(String text, String source = "", PdfTextShapingMode shapingMode = UnicodeScalar) #PdfTextFallbackPlanPlans fallback coverage with an explicit text shaping mode.
Parameters
- text System.String
- source System.String = ""
- shapingMode OfficeIMO.Pdf.PdfTextShapingMode = UnicodeScalar
public IReadOnlyList<PdfTextRun> PlanTextRuns(String text, String source, PdfTextRun styleTemplate) #IReadOnlyList<PdfTextRun>Plans text and converts a fully covered plan into styled rich text runs assigned to this set's generated font slots.
Parameters
- text System.String
- Text to inspect and convert.
- source System.String
- Optional caller-provided source label such as a block, field, sheet, slide, or converter area.
- styleTemplate OfficeIMO.Pdf.PdfTextRun
- Optional run whose styling is copied to each generated text run.
Returns
Text runs that can be used with rich paragraphs, lists, tables, panels, and canvas text boxes.
public IReadOnlyList<PdfTextRun> PlanTextRuns(String text, String source = "", PdfTextRun styleTemplate = null, PdfTextShapingMode shapingMode = UnicodeScalar) #IReadOnlyList<PdfTextRun>Plans text runs with an explicit text shaping mode.
Parameters
- text System.String
- source System.String = ""
- styleTemplate OfficeIMO.Pdf.PdfTextRun = null
- shapingMode OfficeIMO.Pdf.PdfTextShapingMode = UnicodeScalar
public PdfOptions RegisterFonts(PdfOptions options) #PdfOptionsRegisters every fallback candidate into its generated font family slot, including bold and italic variants.
Parameters
- options OfficeIMO.Pdf.PdfOptions
- PDF options to configure.
Returns
The supplied options for fluent chaining.
public Boolean TryPlanTextRuns(String text, out IReadOnlyList<PdfTextRun> runs, String source, PdfTextRun styleTemplate, PdfConversionReport report, String converter) #BooleanPlans text and returns renderable rich text runs only when every non-layout scalar is covered.
Parameters
- text System.String
- Text to inspect and convert.
- runs System.Collections.Generic.IReadOnlyList{OfficeIMO.Pdf.PdfTextRun}@
- Renderable rich text runs when the plan is fully covered; otherwise an empty collection.
- source System.String
- Optional caller-provided source label such as a block, field, sheet, slide, or converter area.
- styleTemplate OfficeIMO.Pdf.PdfTextRun
- Optional run whose styling is copied to each generated text run.
- report OfficeIMO.Pdf.PdfConversionReport
- Optional conversion report that receives missing-glyph diagnostics from incomplete plans.
- converter System.String
- Converter or adapter name used when writing diagnostics to report.
Returns
true when runs contains a fully covered renderable plan; otherwise false.
public Boolean TryPlanTextRuns(String text, out IReadOnlyList<PdfTextRun> runs, String source = "", PdfTextRun styleTemplate = null, PdfConversionReport report = null, String converter = "OfficeIMO.Pdf", PdfTextShapingMode shapingMode = UnicodeScalar) #BooleanTries to plan renderable text runs with an explicit text shaping mode.
Parameters
- text System.String
- runs System.Collections.Generic.IReadOnlyList{OfficeIMO.Pdf.PdfTextRun}@
- source System.String = ""
- styleTemplate OfficeIMO.Pdf.PdfTextRun = null
- report OfficeIMO.Pdf.PdfConversionReport = null
- converter System.String = "OfficeIMO.Pdf"
- shapingMode OfficeIMO.Pdf.PdfTextShapingMode = UnicodeScalar
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public IReadOnlyList<PdfEmbeddedFontFallbackCandidate> Candidates { get; } #Fallback font candidates in priority order.
public IReadOnlyList<PdfStandardFont> FontSlots { get; } #Generated standard-font family slots ordered the same way as Candidates.
public IReadOnlyList<String> FontFamilyNames { get; } #Named embedded font families ordered the same way as Candidates. This is populated when the fallback set was created without compatibility slots.
public Boolean UsesNamedFontFamilies { get; } #True when fallback runs use named embedded font families instead of compatibility slots.