[]
        
(Showing Draft Content)

C1.WPF.Viewer.FlexViewerPane

FlexViewerPane Class

Represents a control showing the preview of the associated document.

Inheritance
FlexViewerPane
Namespace: C1.WPF.Viewer
Assembly: C1.WPF.Viewer.dll
Syntax
public class FlexViewerPane : DxHost, IAnimatable, IFrameworkInputElement, IInputElement, ISupportInitialize, IQueryAmbient, IDisposable, IWin32Window, IKeyboardInputSink, ITouchDestination, INotifyPropertyChanged

Constructors

Name Description
FlexViewerPane()

Initializes a new instance of FlexViewerPane control.

Fields

Name Description
ActiveFindMatchHighlightBrushProperty

Identifies the ActiveFindMatchHighlightBrush dependency property.

AllowThumbViewProperty

Identifies the AllowThumbView dependency property.

BusyProperty

Identifies the Busy dependency property.

CloseActionEnabledProperty

Identifies the CloseActionEnabled dependency property.

ContinuousProperty

Identifies the Continuous dependency property.

DocumentSourceProperty

Identifies the DocumentSource dependency property.

FacingPagesProperty

Identifies the FacingPages dependency property.

FindMatchHighlightBrushProperty

Identifies the FindMatchHighlightBrush dependency property.

GeneratingProperty

Identifies the Generating 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.

LimitSearchToCurrentPageProperty

Identifies the LimitSearchToCurrentPage dependency property.

LinkOverpanProperty

Identifies the LinkOverpan dependency property.

LoadingPageForegroundProperty

Identifies the LoadingPageForeground dependency property.

LoadingPageSizeProperty

Identifies the LoadingPageSize dependency property.

MaxZoomFactorProperty

Identifies the MaxZoomFactor dependency property.

MinZoomFactorProperty

Identifies the MinZoomFactor dependency property.

NonPaginatedContentAlignmentProperty

Identifies the NonPaginatedContentAlignment dependency property.

OpenActionEnabledProperty

Identifies the OpenActionEnabled dependency property.

OpenExportedFileProperty

Identifies the OpenExportedFile dependency property.

PaddingProperty

Identifies the Padding dependency property.

PageAreaBackgroundProperty

Identifies the PageAreaBackground dependency property.

PageAreaPaddingProperty

Identifies the PageAreaPadding dependency property.

PageBackgroundProperty

Identifies the PageBackground 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.

RotateViewProperty

Identifies the RotateView dependency property.

ScrollBarsProperty

Identifies the ScrollBars dependency property.

ScrollModeProperty

Identifies the ScrollMode dependency property.

SelectMouseModeProperty

Identifies the SelectMouseMode dependency property.

SelectionHighlightBrushProperty

Identifies the SelectionHighlightBrush dependency property.

SsrsModeProperty

Identifies the SsrsMode dependency property.

StatusTextProperty

Identifies the StatusText dependency property.

ThumbAreaBackgroundProperty

Identifies the ThumbAreaBackground dependency property.

ThumbAreaPaddingProperty

Identifies the ThumbAreaPadding dependency property.

ThumbHotBackgroundProperty

Identifies the ThumbHotBackground dependency property.

ThumbPaddingProperty

Identifies the ThumbPadding dependency property.

ThumbPageBackgroundProperty

Identifies the ThumbPageBackground dependency property.

ThumbPageNumBackgroundProperty

Identifies the ThumbPageNumBackground dependency property.

ThumbPageNumFontSizeProperty

Identifies the ThumbPageNumFontSize dependency property.

ThumbPageNumForegroundProperty

Identifies the ThumbPageNumForeground dependency property.

ThumbPageNumSizeProperty

Identifies the ThumbPageNumSize dependency property.

ThumbPageNumSpacingProperty

Identifies the ThumbPageNumSpacing dependency property.

ThumbPagePreviewSizeProperty

Identifies the ThumbPagePreviewSize dependency property.

ThumbPressedBackgroundProperty

Identifies the ThumbPressedBackground dependency property.

ThumbScrollDirectionProperty

Identifies the ThumbScrollDirection dependency property.

ThumbSelectedBackgroundProperty

Identifies the ThumbSelectedBackground dependency property.

ThumbViewActiveProperty

Identifies the ThumbViewActive dependency property.

ThumbViewModeProperty

Identifies the ThumbViewMode dependency property.

TouchGripBackgroundProperty

Identifies the TouchGripBackground dependency property.

TouchGripBorderBrushProperty

Identifies the TouchGripBorderBrush 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
ActiveFindMatchHighlightBrush

The brush used to highlight the active find match.

ActualSizeCommand

The ICommand that sets zoom to 100%.

AllowThumbView

Specifies whether the Thumbnails view can be activated.

Busy

Indicates whether the viewer pane is currently busy.

CloseActionEnabled

Indicates whether the Close action can be executed.

CloseCommand

The ICommand that implements the Close action.

Continuous

Indicates 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.

DocumentSource

Specifies the document shown by the viewer.

ExportCommand

The ICommand that opens the Export dialog.

FacingPages

Indicates whether to show facing pages side by side, the first page on the right.

FacingPagesCommand

The ICommand that shows facing pages side by side.

FindMatchHighlightBrush

The brush used to highlight each find match except the active one.

FirstPageCommand

The ICommand that goes to the first page.

FourPagesViewCommand

The ICommand that sets layout to four page columns view.

Generating

Indicates whether the document is currently generated.

HasBackwardHistory

Indicates if the user can navigate to the previous position.

HasForwardHistory

Indicates if the user can navigate to the next position.

HasPages

Indicates whether the document has some visible content.

HasParameters

Indicates whether the document has visible parameters.

HasSelection

Indicates whether some text is currently selected.

HasWidePages

Indicates whether the document contains wide pages.

LastPageCommand

The ICommand that goes to the last page.

LimitSearchToCurrentPage

Indicates whether the text search should be limited to current page.

LinkOverpan

The size of margin when scrolling to a link or bookmark.

LoadingPageForeground

The brush used to draw the message on a page which is not loaded yet.

LoadingPageSize

The size of a page which is not loaded yet.

MaxZoomFactor

The maximum allowed zoom factor.

MinZoomFactor

The minimum allowed zoom factor.

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

The alignment of the non-paginated content.

OnePageViewCommand

The ICommand that sets layout to one page column view.

OpenActionEnabled

Indicates whether the Open action can be executed.

OpenCommand

The ICommand that implements the Open action.

OpenExportedFile

Indicates whether the exported document should be opened for preview.

Padding

The amount of outer padding within the control.

PageAreaBackground

The brush used to fill the area behind the document pages.

PageAreaPadding

The amount of padding between pages and the preview window edges.

PageBackground

The brush used to fill the document pages before drawing the content.

PageColumns

The number of page columns shown.

PageCount

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

The number of the currently visible page.

PageOverpan

The size 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

The number of page rows shown in non-continuous mode.

PageSetCount

The number of page sets displayed in non-continuous mode.

PageSetNumber

The number of the current page set for non-continuous mode.

PageSpacing

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.

PrintJobName

Gets or sets the name for the print job.

PrintQueue

Gets or sets the PrintQueue object defining printer to use, can be null to use default printer.

PrintTicket

Gets or sets the PrintTicket object defining the print parameters, can be null to use DefaultPrintTicket.

RefreshCommand

The ICommand that refreshes/reloads the report.

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

Specifies the view rotation angle.

ScrollBars

Specifies which scroll bars should appear in a FlexViewerPane.

ScrollMode

Specifies what to do while scrolling document.

SearchStarted

Gets a value indicating if search mode is started and you can call the SearchNext and SearchPrevious methods.

SelectAllCommand

The ICommand that selects all text in the document.

SelectMouseMode

Indicates whether clicking and dragging with the mouse selects text.

SelectionHighlightBrush

The brush used to highlight text selection.

SsrsMode

Indicates whether the document source is SSRS.

StatusText

The string that is displayed as the current status string.

StopOperationCommand

The ICommand that tries to stop the current operation.

ThumbAreaBackground

The brush used to fill the area behind the page thumbnails.

ThumbAreaPadding

The amount of padding between the thumbnails and the preview window edges.

ThumbHotBackground

The background brush of a 'hot' thumbnail.

ThumbPadding

The amount of padding within a page thumbnail.

ThumbPageBackground

The brush used to fill the area of a thumbnail where the page is drawn.

ThumbPageNumBackground

The brush used to fill the page number background on thumbnails.

ThumbPageNumFontSize

The size of the font used for drawing the page number in thumbnails.

ThumbPageNumForeground

The brush used to draw the page number on thumbnails.

ThumbPageNumSize

The size of the page number area within a thumbnail.

ThumbPageNumSpacing

The amount of spacing between the page number and page content in thumbnails.

ThumbPagePreviewSize

The size of a page preview in thumbnail.

ThumbPressedBackground

The background brush of a pressed thumbnail.

ThumbScrollDirection

Specifies the direction of scrolling for the Thumbnails view.

ThumbSelectedBackground

The background brush of a selected thumbnail.

ThumbViewActive

Indicates if the Thumbnails view is currently active.

ThumbViewMode

Indicates if the Thumbnails view should be activated whenever possible.

TouchGripBackground

The brush used for filling background of a grip handle for text selection with touch.

TouchGripBorderBrush

The brush used for drawing border of a selection grip handle.

TwoPagesViewCommand

The ICommand that sets layout to two page columns view.

UseAsyncRendering

Indicates if the document should be generated asynchronously.

WholePageCommand

The ICommand that sets zoom to whole page.

WideLayout

Indicates whether a multi-column layout is applied to wide reports by default.

WindowClassName

Gets the name of the window class.

ZoomFactor

Specifies the zoom factor (1.0 is actual size).

ZoomInCommand

The ICommand that performs the zoom-in operation.

ZoomMode

Specifies the preview zoom mode.

ZoomOutCommand

The ICommand that performs the zoom-out operation.

Methods

Name Description
ClearHistory()

Clears the navigation history.

ClearSelection()

Removes selection if any exists (not related to search results).

CopySelectionToClipboard()

Copies the selected text into the Clipboard.

CreateDeviceResources()

Creates the GPU-dependent resources, such as SwapChain and DeviceContext.

DiscardDeviceResources()

Discards all GPU-dependent resources.

Dispose(bool)

Clean up any resources being used.

DoZoomIn()

Zooms in.

DoZoomOut()

Zooms out.

Export()

Saves the currently loaded document, allowing the user to select the file name and the output format.

FocusFirstElement(bool)

Moves focus to the first or the last element of the control in tab order.

GetSelectionAsText()

Returns the currently selected text.

NavigateBackward()

Navigates to the previous position.

NavigateForward()

Navigates to the next position.

NavigateToOutlineNode(OutlineNode)

Navigates to the specified OutlineNode.

OnCloseAction(EventArgs)

Raises the CloseAction event on the preview pane.

OnContextMenuOpening(ContextMenuEventArgs)

Fires the ContextMenuPopup and ContextMenuOpening events.

OnContextMenuPopup(bool, int, int)

Raises the ContextMenuPopup event.

OnDoWork()

Does some job in the background thread.

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.

OnOpenAction(EventArgs)

Raises the OpenAction 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.

OnPropertyChanged(string)

Raises the PropertyChanged event.

OnRunWorkerCompleted()

Executes when the background thread is about to finish.

OnSearchAction(SearchActionEventArgs)

Raises the SearchAction event on the preview pane.

Print()

Shows the standard print dialog, allowing the user to print the currently loaded document.

Reflow()

Regenerates the document if applicable.

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.

UpdateAllCommands()

Updates the state of the viewer commands.

Events

Name Description
CloseAction

Occurs when the user presses the Ctrl-F4 keys.

ContextMenuPopup

Occurs when the user right-clicked FlexViewerPane to display the context menu.

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.

OpenAction

Occurs when the user presses the Ctrl-O keys.

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.