OutlineOptions

PdfSaveOptions.OutlineOptions property

Permet de spécifier les options de contour.

public OutlineOptions OutlineOptions { get; }

Remarques

Des plans peuvent être créés à partir de titres et de signets.

Pour les titres, le niveau de plan est déterminé par le niveau du titre.

Il est possible de définir le niveau de titre maximum à inclure dans les contours ou de désactiver complètement les contours de titre.

Pour les signets, le niveau de plan peut être défini dans les options comme valeur par défaut pour tous les signets ou comme valeurs individuelles pour des signets particuliers.

De plus, les contours peuvent être exportés au format XPS en utilisant le mêmeOutlineOptions classe.

Exemples

Montre comment limiter le niveau des titres qui apparaîtront dans le plan d’un document PDF enregistré.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Insère des titres pouvant servir d'entrées de table des matières des niveaux 1, 2, puis 3.
builder.ParagraphFormat.StyleIdentifier = StyleIdentifier.Heading1;

Assert.True(builder.ParagraphFormat.IsHeading);

builder.Writeln("Heading 1");

builder.ParagraphFormat.StyleIdentifier = StyleIdentifier.Heading2;

builder.Writeln("Heading 1.1");
builder.Writeln("Heading 1.2");

builder.ParagraphFormat.StyleIdentifier = StyleIdentifier.Heading3;

builder.Writeln("Heading 1.2.1");
builder.Writeln("Heading 1.2.2");

// Crée un objet "PdfSaveOptions" que l'on peut passer à la méthode "Save" du document
// pour modifier la façon dont cette méthode convertit le document en .PDF.
PdfSaveOptions saveOptions = new PdfSaveOptions();
saveOptions.SaveFormat = SaveFormat.Pdf;

// Le document PDF de sortie contiendra un plan, qui est une table des matières répertoriant les titres dans le corps du document.
// Cliquer sur une entrée de ce plan nous amènera à l'emplacement de son en-tête respectif.
// Définissez la propriété "HeadingsOutlineLevels" sur "2" pour exclure du plan tous les titres dont les niveaux sont supérieurs à 2.
// Les deux derniers titres que nous avons insérés ci-dessus n'apparaîtront pas.
saveOptions.OutlineOptions.HeadingsOutlineLevels = 2;

doc.Save(ArtifactsDir + "PdfSaveOptions.HeadingsOutlineLevels.pdf", saveOptions);

Montre comment travailler avec des niveaux hiérarchiques qui ne contiennent aucun titre correspondant lors de l’enregistrement d’un document PDF.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Insère des titres pouvant servir d'entrées de table des matières des niveaux 1 et 5.
builder.ParagraphFormat.StyleIdentifier = StyleIdentifier.Heading1;

Assert.True(builder.ParagraphFormat.IsHeading);

builder.Writeln("Heading 1");

builder.ParagraphFormat.StyleIdentifier = StyleIdentifier.Heading5;

builder.Writeln("Heading 1.1.1.1.1");
builder.Writeln("Heading 1.1.1.1.2");

// Crée un objet "PdfSaveOptions" que l'on peut passer à la méthode "Save" du document
// pour modifier la façon dont cette méthode convertit le document en .PDF.
PdfSaveOptions saveOptions = new PdfSaveOptions();

// Le document PDF de sortie contiendra un plan, qui est une table des matières répertoriant les titres dans le corps du document.
// Cliquer sur une entrée de ce plan nous amènera à l'emplacement de son en-tête respectif.
// Définissez la propriété "HeadingsOutlineLevels" sur "5" pour inclure tous les titres des niveaux 5 et inférieurs dans le plan.
saveOptions.OutlineOptions.HeadingsOutlineLevels = 5;

// Ce document contient des titres de niveaux 1 et 5, et aucun titre de niveaux 2, 3 et 4.
// Le document PDF de sortie traitera les niveaux de plan 2, 3 et 4 comme "manquants".
// Fixe la propriété "CreateMissingOutlineLevels" à "true" pour inclure tous les niveaux manquants dans le plan,
// laissant les entrées de plan vides car il n'y a pas de titres utilisables.
// Fixe la propriété "CreateMissingOutlineLevels" à "false" pour ignorer les niveaux hiérarchiques manquants,
// et traite les titres du plan de niveau 5 comme étant de niveau 2.
saveOptions.OutlineOptions.CreateMissingOutlineLevels = createMissingOutlineLevels;

doc.Save(ArtifactsDir + "PdfSaveOptions.CreateMissingOutlineLevels.pdf", saveOptions);

Voir également

PdfSaveOptions.OpenHyperlinksInNewWindow PdfSaveOptions.PageMode