FlexViewer Class

Represents a control showing the associated document with additional tools.

Inheritance

object

FlexViewer

Implements

ICanvasResourceCreatorWithDpi

ICanvasResourceCreator

Namespace: C1.WinUI.Viewer

Assembly: C1.WinUI.Viewer.dll

Syntax

public class FlexViewer : Control, ICanvasResourceCreatorWithDpi, ICanvasResourceCreator

Public Class FlexViewer
    Inherits Control
    Implements ICanvasResourceCreatorWithDpi, ICanvasResourceCreator

Constructors

Name	Description
FlexViewer()	Initializes a new instance of a FlexViewer.

Fields

Name	Description
ActualSizeCommandProperty	Identifies the ActualSizeCommand dependency property.
CollectSearchHistoryProperty	Identifies the CollectSearchHistory dependency property.
ContinuousProperty	Identifies the Continuous dependency property.
CopyTextCommandProperty	Identifies the CopyTextCommand dependency property.
DeselectAllCommandProperty	Identifies the DeselectAllCommand dependency property.
DocumentSourceProperty	Identifies the DocumentSource dependency property.
EightPagesViewCommandProperty	Identifies the EightPagesViewCommand dependency property.
ExpandedSplitViewModeProperty	Identifies the ExpandedSplitViewMode dependency property.
FacingPagesCommandProperty	Identifies the FacingPagesCommand dependency property.
FacingPagesProperty	Identifies the FacingPages dependency property.
FirstPageCommandProperty	Identifies the FirstPageCommand dependency property.
FourPagesViewCommandProperty	Identifies the FourPagesViewCommand dependency property.
LastPageCommandProperty	Identifies the LastPageCommand dependency property.
LimitSearchToCurrentPageProperty	Identifies the LimitSearchToCurrentPage dependency property.
LinkOverpanProperty	Identifies the LinkOverpan dependency property.
LoadingPageSizeProperty	Identifies the LoadingPageSize dependency property.
MatchCaseProperty	Identifies the MatchCase dependency property.
MatchWholeWordProperty	Identifies the MatchWholeWord dependency property.
MinExpandedContentWidthProperty	Identifies the MinExpandedContentWidth dependency property.
MinExpandedSplitViewWidthProperty	Identifies the MinExpandedSplitViewWidth dependency property.
MinPreviewPanelWidthProperty	Identifies the MinPreviewPanelWidth dependency property.
MinToolPanelWidthProperty	Identifies the MinToolPanelWidth dependency property.
MinTopSearchBarWidthProperty	Identifies the MinTopSearchBarWidth dependency property.
NavigateBackwardCommandProperty	Identifies the NavigateBackwardCommand dependency property.
NavigateForwardCommandProperty	Identifies the NavigateForwardCommand dependency property.
NextPageCommandProperty	Identifies the NextPageCommand dependency property.
NonPaginatedContentAlignmentProperty	Identifies the NonPaginatedContentAlignment dependency property.
OnePageViewCommandProperty	Identifies the OnePageViewCommand dependency property.
OneRowViewCommandProperty	Identifies the OneRowViewCommand dependency property.
PageAreaBackgroundProperty	Identifies the PageAreaBackground dependency property.
PageAreaPaddingProperty	Identifies the PageAreaPadding dependency property.
PageBackgroundProperty	Identifies the PageBackground dependency property.
PageBorderBrushProperty	Identifies the PageBorderBrush dependency property.
PageColumnsProperty	Identifies the PageColumns dependency property.
PageOverpanProperty	Identifies the PageOverpan dependency property.
PageRowsProperty	Identifies the PageRows dependency property.
PageSpacingProperty	Identifies the PageSpacing dependency property.
PageWidthCommandProperty	Identifies the PageWidthCommand dependency property.
PreviousPageCommandProperty	Identifies the PreviousPageCommand dependency property.
PrintCommandProperty	Identifies the PrintCommand dependency property.
RotateClockwiseCommandProperty	Identifies the RotateClockwiseCommand dependency property.
RotateCounterClockwiseCommandProperty	Identifies the RotateCounterClockwiseCommand dependency property.
RotateViewProperty	Identifies the RotateView dependency property.
SelectAllCommandProperty	Identifies the SelectAllCommand dependency property.
StatusBackgroundProperty	Identifies the StatusBackground dependency property.
StatusBorderBrushProperty	Identifies the StatusBorderBrush dependency property.
StatusForegroundProperty	Identifies the StatusForeground dependency property.
ThreeRowsViewCommandProperty	Identifies the ThreeRowsViewCommand dependency property.
ThumbnailOverBackgroundProperty	Identifies the ThumbnailOverBackground dependency property.
ThumbnailPageNumBackgroundProperty	Identifies the ThumbnailPageNumBackground dependency property.
ThumbnailPageNumForegroundProperty	Identifies the ThumbnailPageNumForeground dependency property.
ThumbnailScaleProperty	Identifies the ThumbnailScale dependency property.
ThumbnailSelectedBackgroundProperty	Identifies the ThumbnailSelectedBackground dependency property.
ThumbnailSelectedOverBackgroundProperty	Identifies the ThumbnailSelectedOverBackground dependency property.
ToolMenuWidthProperty	Identifies the ToolMenuWidth dependency property.
TwoPagesViewCommandProperty	Identifies the TwoPagesViewCommand dependency property.
TwoRowsViewCommandProperty	Identifies the TwoRowsViewCommand dependency property.
UseIncrementalSearchProperty	Identifies the UseIncrementalSearch dependency property.
WholePageCommandProperty	Identifies the WholePageCommand dependency property.
WideLayoutProperty	Identifies the WideLayout dependency property.
ZoomFactorProperty	Identifies the ZoomFactor dependency property.
ZoomModeProperty	Identifies the ZoomMode dependency property.

Properties

Name	Description
ActiveTool	Gets the value identifying the tool panel that is currently visible.
ActualSizeCommand	The ICommand that sets zoom to 100%.
CollectSearchHistory	Indicates whether the search history should be collected and shown when the user types in the search box.
Continuous	Gets or sets a value indicating whether to show document pages continuously.
CopyTextCommand	The ICommand that copies the selected text to Clipboard.
DeselectAllCommand	The ICommand that deselects all text in the document.
Device
DocumentSource	Gets or sets the document source which is used to generate a report.
Dpi
EightPagesViewCommand	The ICommand that sets layout to eight page columns view.
ExpandedSplitViewMode	Gets or sets a value specifying how the SplitView is shown in the expanded mode.
FacingPages	Gets or sets a value indicating whether to show facing pages side by side, the first page on the right.
FacingPagesCommand	The ICommand that shows facing pages side by side.
FirstPageCommand	The ICommand that goes to the first page.
FourPagesViewCommand	The ICommand that sets layout to four page columns view.
IsExpandedContent	Gets a value indicating if the tool and preview panels are displayed side by side.
LastPageCommand	The ICommand that goes to the last page.
LimitSearchToCurrentPage	Gets or sets a value indicating whether the text search should be limited to current page.
LinkOverpan	Gets or sets the margin when scrolling to a link or bookmark.
LoadingPageSize	Gets or sets the size of a page which is not loaded yet.
MatchCase	Gets or sets a value indicating if search should match case.
MatchWholeWord	Gets or sets a value indicating if search should match the whole word.
MinExpandedContentWidth	Gets or sets the minimal width of the content panel when the tool and preview panels are displayed side by side.
MinExpandedSplitViewWidth	Gets or sets the minimal width of the control when the SplitView uses the expanded mode.
MinPreviewPanelWidth	Gets or sets the minimal width of the preview panel in the expanded display mode.
MinToolPanelWidth	Gets or sets the minimal width of the tools panel in the expanded display mode.
MinTopSearchBarWidth	Gets or sets the minimal width of the top search bar. Search bar will be moved to the bottom if there is not enough space.
NavigateBackwardCommand	The ICommand that navigates to the previous position.
NavigateForwardCommand	The ICommand that navigates to the next position.
NextPageCommand	The ICommand that goes to the next page.
NonPaginatedContentAlignment	Gets or sets the alignment of the non-paginated content.
OnePageViewCommand	The ICommand that sets layout to one page column view.
OneRowViewCommand	The ICommand that sets the non-continuous layout to one row view.
PageAreaBackground	Gets or sets a Microsoft.Graphics.Canvas.Brushes.CanvasSolidColorBrush which provides background for the page area.
PageAreaPadding	Gets or sets the amount of padding between pages and the preview window edges.
PageBackground	Gets or sets a Microsoft.UI.Xaml.Media.SolidColorBrush used for filling the page content.
PageBorderBrush	Gets or sets a Microsoft.UI.Xaml.Media.SolidColorBrush used for drawing page borders.
PageColumns	Gets or sets the number of page columns shown.
PageOverpan	Gets or sets the portion of the previous page that remains visible when the user navigates to the next page.
PageRows	Gets or sets the number of page rows shown in non-continuous mode.
PageSpacing	Gets or sets the amount of padding between pages in the preview.
PageWidthCommand	The ICommand that sets zoom to page width.
Pane	Gets the hosted FlexViewerPane control.
PreviousPageCommand	The ICommand that goes to the previous page.
PrintCommand	The ICommand that opens the Print dialog.
RotateClockwiseCommand	The ICommand that rotates pages by 90 degrees clockwise relative to the current orientation.
RotateCounterClockwiseCommand	The ICommand that rotates pages by 90 degrees counter-clockwise relative to the current orientation.
RotateView	Gets or sets a value indicating if the viewed pages are rotated by the specified angle.
SearchHistory	Gets the list of the collected search strings.
SelectAllCommand	The ICommand that selects all text in the document.
StatusBackground	Gets or sets a Microsoft.UI.Xaml.Media.Brush which provides background for the status panel.
StatusBorderBrush	Gets or sets a Microsoft.UI.Xaml.Media.Brush which is used for drawing border of the status panel.
StatusForeground	Gets or sets a Microsoft.UI.Xaml.Media.Brush which is used for drawing text of the status panel.
ThreeRowsViewCommand	The ICommand that sets the non-continuous layout to three rows view.
ThumbnailOverBackground	Gets or sets a Microsoft.UI.Xaml.Media.Brush used for filling background for a hovered thumbnail.
ThumbnailPageNumBackground	Gets or sets a Microsoft.UI.Xaml.Media.Brush used for filling page number label on a thumbnail.
ThumbnailPageNumForeground	Gets or sets a Microsoft.UI.Xaml.Media.Brush used for drawing page number label on a thumbnail.
ThumbnailScale	Gets or sets the scale of the page thumbnails.
ThumbnailSelectedBackground	Gets or sets a Microsoft.UI.Xaml.Media.Brush used for filling background for a selected thumbnail.
ThumbnailSelectedOverBackground	Gets or sets a Microsoft.UI.Xaml.Media.Brush used for filling background for a selected hovered thumbnail.
ToolMenuItems	Gets the collection of items displayed in the Tools menu.
ToolMenuWidth	Gets or sets a value specifying the width of the control's tool menu.
TwoPagesViewCommand	The ICommand that sets layout to two page columns view.
TwoRowsViewCommand	The ICommand that sets the non-continuous layout to two rows view.
UseIncrementalSearch	Indicates if "search as you type" method of search should be used.
WholePageCommand	The ICommand that sets zoom to whole page.
WideLayout	Gets or sets a value indicating whether a multi-column layout is applied to wide reports by default.
ZoomFactor	Gets or sets the zoom factor (1.0 is actual size).
ZoomMode	Gets or sets the preview zoom mode.

Methods

Name	Description
ConvertDipsToPixels(float, CanvasDpiRounding)
ConvertPixelsToDips(int)
HandleResuming(bool)	Call this method from a handler of the Application.Resuming event.
HandleSuspending(bool)	Call this method from a handler of the Application.Suspending event.
HideToolPanel()	Hides the tool panel that is currently visible.
OnApplyTemplate()
OnNavigateToCustomTool(CustomToolEventArgs)	Raises the NavigateToCustomTool event.
OnPrepareToolMenu()	Raises the PrepareToolMenu event.
SetPrintHandler(IPrintUIHandler)
ShowToolPanel(FlexViewerTool, bool)	Shows the specified tool panel or hides the panel if it is currently visible.

Events

Name	Description
NavigateToCustomTool	Occurs when the user clicks the custom tool menu item.
PrepareToolMenu	Occurs after adding the default items to the Tools menu.