Class Outline

The Outline class shows a document outline (bookmarks) that can be used to navigate the Document in the PDFViewCtrl.

Inheritance
System.Object
Windows.UI.Xaml.DependencyObject
Windows.UI.Xaml.UIElement
Windows.UI.Xaml.FrameworkElement
Windows.UI.Xaml.Controls.Control
Windows.UI.Xaml.Controls.UserControl
Outline
Implements
Windows.UI.Composition.IAnimationObject
Windows.UI.Composition.IVisualElement
Namespace: pdftron.PDF.Tools.Controls
Assembly: pdftron.PDF.Tools.dll
Syntax
public sealed class Outline : UserControl, IDependencyObject, IDependencyObject2, IUIElement, IUIElement2, IUIElement3, IUIElement4, IUIElement5, IUIElement7, IUIElement8, IUIElement9, IUIElement10, IUIElementOverrides, IUIElementOverrides7, IUIElementOverrides8, IUIElementOverrides9, IAnimationObject, IVisualElement, IFrameworkElement, IFrameworkElement2, IFrameworkElement3, IFrameworkElement4, IFrameworkElement6, IFrameworkElement7, IFrameworkElementProtected7, IFrameworkElementOverrides, IFrameworkElementOverrides2, IControl, IControl2, IControl3, IControl4, IControl5, IControl7, IControlProtected, IControlOverrides, IControlOverrides6, IUserControl

Constructors

Outline()

Creates a new outline (bookmark) control without any association with a PDFViewCtrl. Use the PDFViewCtrl property to associated the outline control with a document and populate it.

Declaration
public Outline()

Outline(PDFViewCtrl)

Creates a new outline (bookmark) control associated with a PDFViewCtrl. The control will show the bookmarks in the document that is open in the PDFViewCtrl.

Declaration
public Outline(PDFViewCtrl ctrl)
Parameters
Type Name Description
PDFViewCtrl ctrl

Fields

DocumentModified

Declaration
public Outline.DocumentModifiedEventHandler DocumentModified
Field Value
Type Description
Outline.DocumentModifiedEventHandler

PageChanged

Declaration
public Outline.PageChangedDelegate PageChanged
Field Value
Type Description
Outline.PageChangedDelegate

Properties

DocumentTitle

Declaration
public string DocumentTitle { get; set; }
Property Value
Type Description
System.String

IsEditEnabled

Enable weather the ability to edit the outline is enabled or disabled

Declaration
public bool IsEditEnabled { get; set; }
Property Value
Type Description
System.Boolean

NavigationStack

Declaration
public NavigationStack NavigationStack { get; set; }
Property Value
Type Description
NavigationStack

PDFViewCtrl

The PDFViewCtrl form which the outline should get the document with PDFs.

Declaration
public PDFViewCtrl PDFViewCtrl { get; set; }
Property Value
Type Description
PDFViewCtrl

ViewModel

Declaration
public OutlineViewModel ViewModel { get; }
Property Value
Type Description
OutlineViewModel

Methods

Dispose()

Unsubscribes the ViewModel from events and Disposes the ViewModel

Declaration
public void Dispose()

GetState()

Declaration
public List<int> GetState()
Returns
Type Description
List<System.Int32>

GoBack()

Will go back if possible.

Declaration
public bool GoBack()
Returns
Type Description
System.Boolean

Return true if it went back, false otherwise

Hide()

Animates the Bookmarks panel of the screen.

Declaration
public void Hide()

Reset()

Resets the Bookmark display, so that next time it will create bookmarks from scratch.

Declaration
public void Reset()

RestoreState(List<Int32>)

Declaration
public void RestoreState(List<int> list)
Parameters
Type Name Description
List<System.Int32> list

ShowAsync()

Animates the Bookmarks panel onto the screen.

Declaration
public Task ShowAsync()
Returns
Type Description
Task

WaitForOutlineToLoadAsync()

Declaration
public Task WaitForOutlineToLoadAsync()
Returns
Type Description
Task

Events

ItemClicked

Declaration
public event EventHandler<ItemClickEventArgs> ItemClicked
Event Type
Type Description
Windows.Foundation.EventHandler<Windows.UI.Xaml.Controls.ItemClickEventArgs>

Implements

Windows.UI.Composition.IAnimationObject
Windows.UI.Composition.IVisualElement

Extension Methods