Class OutlineElement
Represents document outline elements. These allow the user to navigate interactively from one part of the document to another.
Outline elements can be nested in a tree-like structure where elements are collapsible/expandable to hide/reveal their subtrees.
Inheritance
Namespace: PSPDFKit.Pdf
Assembly: PSPDFKit.dll
Syntax
public sealed class OutlineElementProperties
Action
The action that will be triggered when the outline element is either clicked or tapped.
Declaration
public IAction Action { get; set; }Property Value
| Type | Description |
|---|---|
| IAction |
Children
Each outline element can have nested outline elements.
Declaration
public IList<OutlineElement> Children { get; set; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<OutlineElement> |
Color
The text color of the outline element title.
Declaration
public Color? Color { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<Windows.UI.Color> |
IsBold
Whether the outline element title is bold.
Declaration
public bool IsBold { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsExpanded
Whether the outline element is expanded and shows its child elements.
Declaration
public bool IsExpanded { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsItalic
Whether the outline element title is italic.
Declaration
public bool IsItalic { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Title
The outline element title, must be human readable.
Declaration
public string Title { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Methods
FromJson(JsonObject)
Create an outline from json.
Declaration
public static OutlineElement FromJson(JsonObject json)Parameters
| Type | Name | Description |
|---|---|---|
| Windows.Data.Json.JsonObject | json | The json representing the outline. |
Returns
| Type | Description |
|---|---|
| OutlineElement |
ToJson()
Converts the OutlineElement to a Windows.Data.Json.JsonObject.
Declaration
public JsonObject ToJson()Returns
| Type | Description |
|---|---|
| Windows.Data.Json.JsonObject | The outline as json. |