[]
        
(Showing Draft Content)

C1.WPF.FlexViewer.C1FlexViewer

C1FlexViewer Class

Represents a control showing the associated document with additional tools.

Namespace: C1.WPF.FlexViewer
Assembly: C1.WPF.FlexViewer.4.6.2.dll
Syntax
[TemplatePart(Name = "layoutRoot", Type = typeof(Grid))]
[TemplatePart(Name = "mainToolbar", Type = typeof(MainToolbar))]
[TemplatePart(Name = "toolFrame", Type = typeof(Frame))]
[TemplatePart(Name = "splitter", Type = typeof(GridSplitter))]
[TemplatePart(Name = "toolColumn", Type = typeof(ColumnDefinition))]
[TemplatePart(Name = "splitterColumn", Type = typeof(ColumnDefinition))]
[TemplatePart(Name = "searchToolbar", Type = typeof(SearchToolbar))]
[TemplatePart(Name = "fvp", Type = typeof(C1FlexViewerPane))]
[TemplatePart(Name = "statusBar", Type = typeof(NotificationBar))]
[TemplatePart(Name = "contextMenu", Type = typeof(ContextMenu))]
[TemplatePart(Name = "copyMenuItem", Type = typeof(MenuItem))]
[TemplatePart(Name = "selectToolMenuItem", Type = typeof(MenuItem))]
[TemplatePart(Name = "selectAllMenuItem", Type = typeof(MenuItem))]
[TemplatePart(Name = "deselectMenuItem", Type = typeof(MenuItem))]
public class C1FlexViewer : Control, IAnimatable, IFrameworkInputElement, IInputElement, ISupportInitialize, IQueryAmbient

Constructors

Name Description
C1FlexViewer()

Initializes the new instance of the C1FlexViewer control.

Fields

Name Description
ActiveFindMatchHighlightBrushProperty

Identifies the ActiveFindMatchHighlightBrush dependency property.

AllowThumbViewProperty

Identifies the AllowThumbView dependency property.

BackwardForwardVisibleProperty

Identifies the BackwardForwardVisible dependency property.

CloseActionEnabledProperty

Identifies the CloseActionEnabled dependency property.

CloseButtonToolTipProperty

Identifies the CloseButtonToolTip dependency property.

CloseButtonVisibleProperty

Identifies the CloseButtonVisible dependency property.

ContinuousProperty

Identifies the Continuous dependency property.

CurrentPageVisibleOnSearchToolbarProperty

Identifies the CurrentPageVisibleOnSearchToolbar dependency property.

DocumentListVisibleProperty

Identifies the DocumentListVisible dependency property.

DocumentListWidthProperty

Identifies the DocumentListWidth dependency property.

DocumentSourceProperty

Identifies the DocumentSource dependency property.

FacingPagesProperty

Identifies the FacingPages dependency property.

FindMatchHighlightBrushProperty

Identifies the FindMatchHighlightBrush dependency property.

InputFieldWidthProperty

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

MatchCaseProperty

Identifies the MatchCase dependency property.

MatchWholeWordsProperty

Identifies the MatchWholeWords dependency property.

MaxZoomFactorProperty

Identifies the MaxZoomFactor dependency property.

MinToolFrameWidthProperty

Identifies the MinToolFrameWidth dependency property.

MinViewerPaneWidthProperty

Identifies the MinViewerPaneWidth dependency property.

MinZoomFactorProperty

Identifies the MinZoomFactor dependency property.

MultiValueFieldHeightProperty

Identifies the MultiValueFieldHeight dependency property.

NonPaginatedContentAlignmentProperty

Identifies the NonPaginatedContentAlignment dependency property.

OpenActionEnabledProperty

Identifies the OpenActionEnabled dependency property.

OpenButtonToolTipProperty

Identifies the OpenButtonToolTip dependency property.

OpenButtonVisibleProperty

Identifies the OpenButtonVisible dependency property.

OpenExportedFileProperty

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

PageOverpanProperty

Identifies the PageOverpan dependency property.

PageRefreshRateProperty

Identifies the PageRefreshRate dependency property.

PageRowsProperty

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

SearchToolbarPositionProperty

Identifies the SearchToolbarPosition dependency property.

SelectMouseModeProperty

Identifies the SelectMouseMode dependency property.

SelectionHighlightBrushProperty

Identifies the SelectionHighlightBrush dependency property.

SplitterWidthProperty

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

ThumbViewModeProperty

Identifies the ThumbViewMode dependency property.

ToolFrameContentProperty

Identifies the ToolFrameContent dependency property.

ToolFrameWidthProperty

Identifies the ToolFrameWidth dependency property.

TouchGripBackgroundProperty

Identifies the TouchGripBackground dependency property.

TouchGripBorderBrushProperty

Identifies the TouchGripBorderBrush dependency property.

UseAsyncRenderingProperty

Identifies the UseAsyncRendering dependency property.

UseIncrementalSearchProperty

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

BackwardForwardVisible

Specifies whether the Backward and Forward navigation buttons are visible.

CanShowOutlines

Indicates whether the Outlines panel can be shown (if the document has outlines).

CanShowPageSettings

Indicates whether the Page Settings panel can be shown.

CanShowParameters

Indicates whether the Parameters panel can be shown.

CanShowSearchToolbar

Indicates whether the Search toolbar can be shown.

CloseActionEnabled

Indicates whether the Close action can be executed.

CloseButtonToolTip

Specifies the tooltip for the Close button.

CloseButtonVisible

Specifies whether the Close button is visible.

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.

CurrentPageVisibleOnSearchToolbar

Indicates if the "Current Page" button is visible on the Search toolbar.

DeselectAllCommand

The ICommand that deselects all text in the document.

DocumentListCombo

Gets a customizable instance of C1ComboBox which can be used, for example, for displaying the list of reports.

DocumentListVisible

Specifies whether the Document List combobox is visible.

DocumentListWidth

The width of the Document List combobox.

DocumentSource

Gets or sets the document source which is used to generate a report.

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.

InputFieldWidth

The width of numeric/string/enumeration input fields on the Parameters and Page Settings panels.

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.

MatchCase

Indicating if search should match case.

MatchWholeWords

Indicates if search should match the whole words.

MaxZoomFactor

The maximum allowed zoom factor.

MinToolFrameWidth

The minimal width of the tool frame.

MinViewerPaneWidth

The minimal width of the preview pane.

MinZoomFactor

The minimum allowed zoom factor.

MultiValueFieldHeight

Specifies the height of the multi-value input fields on the Parameters panel.

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.

OpenButtonToolTip

Specifies the tooltip for the Open button.

OpenButtonVisible

Specifies whether the Open button is visible.

OpenCommand

The ICommand that implements the Open action.

OpenExportedFile

Indicates whether the exported document should be opened for preview.

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.

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.

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.

Pane

Gets the hosted C1FlexViewerPane control.

PreviousPageCommand

The ICommand that goes to the previous page.

PrintCommand

The ICommand that opens the Print dialog.

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

ScrollMode

Specifies what to do while scrolling document.

SearchToolbarPosition

Specifies position of the Search toolbar.

SearchToolbarVisible

Indicates whether the Search toolbar is visible.

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.

SplitterWidth

The width of the splitter between the tool frame and the preview pane.

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 amount of padding between pages in the preview.

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.

ThumbViewMode

Indicates if the Thumbnails view should be activated whenever possible.

ToolFrameContent

Specifies which content should be displayed in the tool frame.

ToolFrameVisible

Indicates whether the Search toolbar is visible.

ToolFrameWidth

The width of the tool frame.

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.

UseIncrementalSearch

Indicates if "search as you type" method of search should be used.

WholePageCommand

The ICommand that sets zoom to whole page.

WideLayout

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

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
FocusPane()

Moves input focus to the hosted C1FlexViewerPane control.

HideSearchToolbar()

Hides the Search toolbar.

OnApplyTemplate()
OnVisualParentChanged(DependencyObject)

Invoked when the Parent of this element is changed.

ShowSearchToolbar()

Shows the Search toolbar, if possible.

Events

Name Description
CloseAction

Occurs when the user presses the Close button.

OpenAction

Occurs when the user presses the Open button.