C1.WinUI.Viewer.FlexViewerPane

FlexViewerPane Class

Represents a control showing the preview of the associated document.

Inheritance

object

FlexViewerPane

Implements

ICanvasResourceCreatorWithDpi

ICanvasResourceCreator

INotifyPropertyChanged

Namespace: C1.WinUI.Viewer

Assembly: C1.WinUI.Viewer.dll

Syntax

public class FlexViewerPane : Control, ICanvasResourceCreatorWithDpi, ICanvasResourceCreator, INotifyPropertyChanged

Constructors

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

Fields

Name	Description
BusyProperty	Identifies the Busy dependency property.
ContinuousProperty	Identifies the Continuous dependency property.
DocumentSourceProperty	Identifies the DocumentSource dependency property.
FacingPagesProperty	Identifies the FacingPages dependency property.
HasBackwardHistoryProperty	Identifies the HasBackwardHistory dependency property.
HasForwardHistoryProperty	Identifies the HasForwardHistory dependency property.
HasPagesProperty	Identifies the HasPages dependency property.
HasParametersProperty	Identifies the HasParameters dependency property.
HasSelectionProperty	Identifies the HasSelection dependency property.
HasWidePagesProperty	Identifies the HasWidePages dependency property.
IsActualSizeZoomModeProperty	Identifies the IsActualSizeZoomMode dependency property.
IsEightPageColumnsLayoutProperty	Identifies the IsEightPageColumnsLayout dependency property.
IsFourPageColumnsLayoutProperty	Identifies the IsFourPageColumnsLayout dependency property.
IsOnePageColumnLayoutProperty	Identifies the IsOnePageColumnLayout dependency property.
IsOnePageRowLayoutProperty	Identifies the IsOnePageRowLayout dependency property.
IsPageRowsApplicableProperty	Identifies the IsPageRowsApplicable dependency property.
IsPageWidthZoomModeProperty	Identifies the IsPageWidthZoomMode dependency property.
IsThreePageRowsLayoutProperty	Identifies the IsThreePageRowsLayout dependency property.
IsTwoPageColumnsLayoutProperty	Identifies the IsTwoPageColumnsLayout dependency property.
IsTwoPageRowsLayoutProperty	Identifies the IsTwoPageRowsLayout dependency property.
IsWholePageZoomModeProperty	Identifies the IsWholePageZoomMode dependency property.
LimitSearchToCurrentPageProperty	Identifies the LimitSearchToCurrentPage dependency property.
LinkOverpanProperty	Identifies the LinkOverpan dependency property.
LoadingPageSizeProperty	Identifies the LoadingPageSize dependency property.
NonPaginatedContentAlignmentProperty	Identifies the NonPaginatedContentAlignment 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.
PageCountProperty	Identifies the PageCount dependency property.
PageHistoryTrackingProperty	Identifies the PageHistoryTracking dependency property.
PageNumberProperty	Identifies the PageNumber dependency property.
PageOverpanProperty	Identifies the PageOverpan dependency property.
PageRefreshRateProperty	Identifies the PageRefreshRate dependency property.
PageRowsProperty	Identifies the PageRows dependency property.
PageSetCountProperty	Identifies the PageSetCount dependency property.
PageSetNumberProperty	Identifies the PageSetNumber dependency property.
PageSpacingProperty	Identifies the PageSpacing dependency property.
PaginatedProperty	Identifies the Paginated dependency property.
PrintingEnabledProperty	Identifies the PrintingEnabled dependency property.
ReportToolTipProperty	Identifies the ReportToolTip dependency property.
RotateViewProperty	Identifies the RotateView dependency property.
StatusBackgroundProperty	Identifies the StatusBackground dependency property.
StatusBorderBrushProperty	Identifies the StatusBorderBrush dependency property.
StatusForegroundProperty	Identifies the StatusForeground dependency property.
StatusTextProperty	Identifies the StatusText 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.
UseAsyncRenderingProperty	Identifies the UseAsyncRendering dependency property.
WideLayoutProperty	Identifies the WideLayout dependency property.
ZoomFactorProperty	Identifies the ZoomFactor dependency property.
ZoomModeProperty	Identifies the ZoomMode dependency property.

Properties

Name	Description
ActualSizeCommand	The ICommand that sets zoom to 100%.
Busy	Gets the flag indicating whether the viewer pane is currently busy.
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.
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.
HasBackwardHistory	Gets a value indicating if the user can navigate to the previous position.
HasForwardHistory	Gets a value indicating if the user can navigate to the next position.
HasPages	Gets a value indicating if the document has some visible content.
HasParameters	Indicates whether the document has visible parameters.
HasSelection	Gets a value indicating if some text is currently selected.
HasWidePages	Gets a value indicating if the document contains wide pages.
IsActualSizeZoomMode	Gets or sets a value indicating if pages are shown in actual size.
IsEightPageColumnsLayout	Gets or sets a value indicating if eight page columns are shown in paginated mode.
IsFourPageColumnsLayout	Gets or sets a value indicating if four page columns are shown in paginated mode.
IsOnePageColumnLayout	Gets or sets a value indicating if one page column is shown in paginated mode.
IsOnePageRowLayout	Gets or sets a value indicating if one page row is shown in non-continuous mode.
IsPageRowsApplicable	Gets a value indicating if the PageRows property is currently applicable.
IsPageWidthZoomMode	Gets or sets a value indicating if pages are zoomed in or out as necessary to fit the page width in the preview window.
IsThreePageRowsLayout	Gets or sets a value indicating if three page rows are shown in non-continuous mode.
IsTwoPageColumnsLayout	Gets or sets a value indicating if two page columns are shown in paginated mode.
IsTwoPageRowsLayout	Gets or sets a value indicating if two page rows are shown in non-continuous mode.
IsWholePageZoomMode	Gets or sets a value indicating if pages are zoomed in or out as necessary to fit the whole page in the preview window.
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.
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.
PageCount	Gets the number of pages displayed in the preview.
PageHistoryTracking	Indicates whether the changes to the PageNumber or PageSetNumber properties should be collected in history.
PageNumber	Gets or sets the number of the currently visible page.
PageOverpan	Gets or sets the portion of the previous page that remains visible when the user navigates to the next page.
PageRefreshRate	The number of pages generated between the viewer refreshes its layout.
PageRows	Gets or sets the number of page rows shown in non-continuous mode.
PageSetCount	Gets the number of page sets in non-continuous mode.
PageSetNumber	Gets or sets the number of the current page set for 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.
Paginated	Indicates whether the content should be represented as a set of fixed sized pages.
PreviousPageCommand	The ICommand that goes to the previous page.
PrintCommand	The ICommand that opens the Print dialog.
PrintingEnabled	Determines whether default printing UI should be available to end-user.
ReportToolTip	Gets the toooltip string which should be appear over the report element.
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.
SearchStarted	Gets a value indicating if the search mode is started and you can call the SearchNext and SearchPrevious methods.
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.
StatusText	Gets or sets the string that is displayed as the current status string.
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.
TwoPagesViewCommand	The ICommand that sets layout to two page columns view.
TwoRowsViewCommand	The ICommand that sets the non-continuous layout to two rows view.
UseAsyncRendering	Indicates if the document should be generated asynchronously.
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
ClearHistory()	Clears the navigation history.
ClearSelection()	Removes selection if any exists (not related to search results).
ConvertDipsToPixels(float, CanvasDpiRounding)
ConvertPixelsToDips(int)
CopySelectionToClipboard()	Copies the selected text into the Clipboard.
GetSelectionAsText()	Returns the currently selected text.
NavigateBackward()	Navigates to the previous position.
NavigateForward()	Navigates to the next position.
NavigateToOutlineNode(OutlineNode)	Navigates to the specified C1.Document.OutlineNode.
OnApplyTemplate()
OnHyperlinkClicked(HyperlinkClickedEventArgs)	Raises the HyperlinkClicked event on the preview pane.
OnHyperlinkHovered(HyperlinkHoveredEventArgs)	Raises the HyperlinkHovered event on the preview pane.
OnLongOperation(LongOperationEventArgs)	Raises the LongOperation event on the preview pane.
OnOperationError(OperationErrorEventArgs)	Raises the OperationError event on the preview pane.
OnOutlineClicked(OutlineClickedEventArgs)	Raises the OutlineClicked event on the preview pane.
OnSearchAction(SearchActionEventArgs)	Raises the SearchAction event on the preview pane.
ResetSearch()	Stops the search mode and removes highlighting from the found text fragments.
SearchNext()	Searches for the next occurrence.
SearchPrevious()	Searches for the previous occurrence.
SearchText(string, bool, bool, bool)	Starts searching text with the specified parameters.
SelectAll()	Selects all text in the document or on the current page (for non-paginated mode).
SetPageIndex(int, bool)	Sets the 0-based index of the currently visible page.
SetPageSetIndex(int, bool)	Sets the 0-based index of the current page set in non-continuous mode.
ShowPrintUI()	Initiates the user interface for printing a report.
ShowTextPosition(C1FoundPosition)	Navigates to the specified position that was found with one of the Search methods.
UpdateAllCommands()	Updates the state of the viewer commands.

Events

Name	Description
HyperlinkClicked	Occurs when the user clicked some active element, such as a hyperlink or expanding/collapsing icon.
HyperlinkHovered	Occurs when the mouse pointer hovered some active element, such as a hyperlink or expanding/collapsing icon.
LongOperation	Occurs periodically when a long operation is in progress.
OperationError	Occurs in case of an exception thrown during a report operation, such as Generate or Export.
OutlineClicked	Occurs when the user clicked an outline element.
PropertyChanged	Occurs when a property of the FlexViewerPane that is not inherited from the base class changes.
SearchAction	Occurs when the user presses Ctrl-F, F3 or Shift-F3 keys.