C1.Win.FlexViewer.C1FlexViewerDialog

C1FlexViewerDialog Class

Represents a C1RibbonForm with C1FlexViewer control on it.

Inheritance

object

C1FlexViewerDialog

Implements

ISupportInitialize

Namespace: C1.Win.FlexViewer

Assembly: C1.Win.FlexViewer.4.8.dll

Syntax

[ToolboxBitmap(typeof(C1FlexViewerDialog), "C1FlexViewerDialog.png")]
public class C1FlexViewerDialog : C1RibbonForm, ISupportInitialize

Constructors

Name	Description
C1FlexViewerDialog()	Initializes a new instance of a C1FlexViewerDialog.
C1FlexViewerDialog(IContainer)	Initializes a new instance of a C1FlexViewerDialog.

Properties

Name	Description
ActiveFindMatchHighlightColor	Gets or sets the color used to highlight the active find match.
Busy	Gets or sets the flag indicating whether the viewer pane is currently busy. Some actions (especially those that could cause significant changes in the preview pane's state) raise this flag themselves, and cannot be performed when this flag was raised by another operation. This flag should be tested before attempting to change viewer pane's properties or invoke methods on it.
CanShowOutlines	Gets or sets a value indicating if the Outlines panel can be displayed.
CanShowParameters	Gets or sets a value indicating if the Parameters panel can be displayed.
CanShowThumbnails	Gets or sets a value indicating if the Thumbnails view can be activated.
ContextMenuElements	Gets the elements displayed in the context menu.
Continuous	Gets or sets a value indicating whether to show document pages continuously.
CustomCursors	The custom cursors used by C1FlexViewerPane.
DefaultMinimumSize	Gets the default minimum size of the control.
DocumentSource	Gets or sets the document shown by the viewer.
FacingPages	Gets or sets a value indicating whether to show facing pages side by side, the first page on the right.
FindMatchHighlightColor	Gets or sets the color used to highlight each find match except the active one.
Font	Gets or sets the font of the text displayed by the dialog.
FormBorderStyle	Gets or sets the border style of the form.
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.
HasOutlines	Gets a value indicating if the report has outlines.
HasPages	Gets a value indicating if the document has some visible content.
HasParameters	Gets a value indicating if the report has parameters.
HasSelection	Gets a value indicating if some text is currently selected.
LimitSearchToCurrentPage	Gets or sets a value indicating whether the text search should be limited to current page.
LinkOverpan	Gets or sets the size of margin when scrolling to a link or bookmark.
LoadingPageFont	Gets or sets the font used for drawing the message on a page which is not loaded yet.
LoadingPageForeColor	Gets or sets the color used to draw the message on a page which is not loaded yet.
LoadingPageSize	Gets or sets the size of a page which is not loaded yet.
Location	Gets or sets the Point that represents the upper-left corner of the Form in screen coordinates.
MaxZoomFactor	Gets or sets the maximum allowed zoom factor.
MaximumSize	Gets the maximum size the form can be resized to.
MinZoomFactor	Gets or sets the minimum allowed zoom factor.
MinimumSize	Gets or sets the minimum size the form can be resized to.
MiscStrings	Gets the miscellaneous UI strings.
NonPaginatedContentAlignment	Gets or sets the alignment of the non-paginated content.
Opacity	Gets or sets the opacity level of the form.
OpenExportedFile	Gets or sets a value indicating whether the exported document should be opened after exporting to a file.
OuterSpacing	Gets or sets the amount of padding between the outer elements of a C1FlexViewerPane.
OutlineAreaBackColor	Gets or sets the background color for the outline panel.
OutlineBackColorHot	Gets or sets the background color used for filling outline items in 'hot' state.
OutlineBackColorHotSelected	Gets or sets the background color used for filling the selected outline item in 'hot' state.
OutlineBackColorNormal	Gets or sets the background color used for filling outline items in normal state.
OutlineBackColorSelected	Gets or sets the background color used for filling the selected outline item.
OutlineButtonBackColorHot	Gets or sets the background color of the expand/collapse outline button in 'hot' state.
OutlineButtonBackColorNormal	Gets or sets the background color of the expand/collapse outline button in normal state.
OutlineButtonBackColorPressed	Gets or sets the background color of the expand/collapse outline button in pressed state.
OutlineButtonBorderColorHot	Gets or sets the border color of the expand/collapse outline button in 'hot' state.
OutlineButtonBorderColorNormal	Gets or sets the border color of the expand/collapse outline button in normal state.
OutlineButtonBorderColorPressed	Gets or sets the border color of the expand/collapse outline button in pressed state.
OutlineButtonForeColorHot	Gets or sets the foreground color of the expand/collapse outline button in 'hot' state.
OutlineButtonForeColorNormal	Gets or sets the foreground color of the expand/collapse outline button in normal state.
OutlineButtonForeColorPressed	Gets or sets the foreground color of the expand/collapse outline button in pressed state.
OutlineFont	Gets or sets the font used for outlines.
OutlineForeColorHot	Gets or sets the foreground color used for drawing text on 'hot' outline items.
OutlineForeColorHotSelected	Gets or sets the foreground color used for drawing text on a selected outline item when it is also 'hot'.
OutlineForeColorNormal	Gets or sets the foreground color used for drawing text on the outline items in normal state.
OutlineForeColorSelected	Gets or sets the foreground color used for drawing text on a selected outline item.
OutlineIndentStep	Gets or sets the horizontal offset of the nested node text in the outline tree.
OutlineIndent_0	Gets or sets the amount of horizontal spacing before the text of the root node in the outline tree.
OutlineIndent_1	Gets or sets the amount of horizontal spacing before the text of the first nested node in the outline tree.
OutlineLineColor	Gets or sets the color of a vertical line drawn for child outline nodes.
OutlineLineGap	Gets or sets the gap between the vertical line and text in nested nodes of the outline tree.
OutlinePanelAlignment	Gets or sets the alignment for the Outlines panel.
OutlinePanelWidth	Gets or sets the width of the outline panel.
OutlineRightPadding	Gets or sets the amount of spacing to the right of the outline text.
OutlineVerticalPadding	Gets or sets the amount of spacing above and below the outline text.
Padding	Gets or sets the amount of outer padding within the control.
PageAreaBackColor	Gets or sets the color used to fill the area behind the document pages.
PageAreaPadding	Gets or sets the amount of padding between pages and the preview window edges.
PageColumns	Gets or sets the number of page columns shown.
PageCount	Gets the number of pages displayed in the preview.
PageFillColor	Gets or sets the color used to fill the document pages before drawing the content.
PageIndex	Gets or sets the 0-based index of the currently visible page. If several pages are visible, this property indicates the page with the most surface shown. When the property is set, the new start page's top left corner is aligned with the preview window's top left corner.
PageOverpan	Gets or sets the size of the previous page that remains visible when the user navigates to the next page.
PageRefreshRate	Gets or sets 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 numbers of page sets in non-continuous mode.
PageSetIndex	Gets or sets the 0-based index of the current page set in non-continuous mode.
PageSettings	Gets or sets page settings associated with the viewer.
PageSpacing	Gets or sets the amount of padding between pages in the preview.
Paginated	Gets or sets a value indicating whether the content should be represented as set of fixed sized pages.
Pane	Gets the hosted C1FlexViewerPane.
ParamErrorForeColor	Gets or sets the color of the validation error message displayed for the report parameters.
ParamHeaderBackColor	Gets or sets the background color of the Parameters panel header.
ParamHeaderForeColor	Gets or sets the foreground color of the Parameters panel header.
ParamPanelAlignment	Gets or sets the alignment for the Parameters panel.
ParamPanelVisible	Gets a value indicating if the Parameters panel is currently visible.
ParamPanelWidth	Gets or sets the width of the Parameters panel.
ParameterStrings	Gets the UI strings displayed on the Parameters panel.
PrintJobName	Gets or sets the name for the print job.
RibbonElements	Gets the customizable elements for Ribbon items.
RibbonGroups	Gets the customizable elements for Ribbon groups.
RotateView	Gets or sets a value indicating if the viewed pages are rotated by the specified angle.
ScrollBars	Gets or sets which scroll bars should appear in a C1FlexViewerPane.
SearchBarElements	Gets the elements displayed in the SearchBar.
SearchStarted	Gets a value indicating if search mode is started and you can call the SearchNext and SearchPrevious methods.
SelectMouseMode	Gets or sets a value indicating whether clicking and dragging with the mouse selects text.
SelectionHighlightColor	Gets or sets the color used to highlight text selection.
ShowExportOptions	Gets or sets a value indicating whether the Options dialog should be shown to the user before exporting the document.
ShowOutlines	Gets or sets a value indicating if the Outlines panel should be displayed whenever possible.
ShowParameters	Gets or sets a value indicating if the Parameters panel should be displayed whenever possible.
ShowThumbnails	Gets or sets a value indicating if the Thumbnails view should be activated whenever possible.
SplitterColor	Gets or sets the color of the splitter for resizing the outline and parameters panels.
SplitterWidth	Gets or sets the width of the splitters for the Outlines and Parameters panels.
SsrsMode	Indicates if the document source is SSRS.
StatusBarElements	Gets the elements displayed in the StatusBar.
StatusText	Gets or sets the current status string.
ThumbAreaBackColor	Gets or sets the color used to fill the area behind the page thumbnails.
ThumbAreaPadding	Gets or sets the amount of padding between the thumbnails and the preview window edges.
ThumbBackColorHot	Gets or sets the background color of a 'hot' thumbnail.
ThumbBackColorPressed	Gets or sets the background color of a pressed thumbnail.
ThumbBackColorSelected	Gets or sets the background color of a selected thumbnail.
ThumbPadding	Gets or sets the amount of padding within a page thumbnail.
ThumbPageAreaBackColor	Gets or sets the color used to fill the area of a thumbnail where the page is drawn.
ThumbPageNumBackColor	Gets or sets the color used to fill the page number background on thumbnails.
ThumbPageNumFont	Gets or sets the font used for drawing numbers on page thumbnails.
ThumbPageNumForeColor	Gets or sets the color used to draw the page number on thumbnails.
ThumbPageNumSize	Gets or sets the size of the page number area within a thumbnail.
ThumbPageNumSpacing	Gets or sets the amount of spacing between the page number and page content in thumbnails.
ThumbPagePreviewSize	Gets or sets the size of a page preview in thumbnail.
ThumbScrollDirection	Gets or sets the direction of scrolling for the Thumbnails view.
ToolBarElements	Gets the customizable elements for items of Ribbon toolbar.
UseAsyncRendering	Gets or sets a value indicating if the document should be generated asynchronously.
UseIncrementalSearch	Gets or sets a value indicating if "search as you type" method of search should be used.
Viewer	Gets the hosted C1FlexViewer.
Visible	Gets or sets a value indicating whether the dialog is displayed.
ZoomDialogStrings	Gets the UI strings for the Zoom dialog.
ZoomFactor	Gets or sets the zoom factor (1 is actual size).
ZoomMode	Gets or sets the preview zoom mode.

Methods

Name	Description
BeginInit()
ClearHistory()	Clears the navigation history.
ClearSelection()	Removes selection if any exists (not related to search results).
CopySelectionToClipboard()	Copies the selected text into the Clipboard.
Dispose(bool)	Clean up any resources being used.
DoZoomIn()	Zooms in.
DoZoomOut()	Zooms out.
EndInit()
Export()	Saves the currently loaded document, allowing the user to select the file name and the output format.
ExportToXps(Stream)	Saves the document as XPS (on Windows 7) or as OpenXPS (on Windows 8+) to the specified stream.
ExportToXps(string)	Saves the document to an XPS file (.xps on Windows 7, .oxps on Windows 8+).
GetSelectionAsText()	Returns the currently selected text.
NavigateBackward()	Navigates to the previous position.
NavigateForward()	Navigates to the next position.
OnShown(EventArgs)
PageSetup()	Invokes the standard page setup dialog. If the user presses OK in the dialog, the currently loaded document reflows if reflow is supported.
Print()	Shows the standard print dialog, allowing the user to print the currently loaded document.
ResetActiveFindMatchHighlightColor()	Resets the ActiveFindMatchHighlightColor to the default value.
ResetFindMatchHighlightColor()	Resets the FindMatchHighlightColor to the default value.
ResetLinkOverpan()	Resets the LinkOverpan to the default value.
ResetLoadingPageForeColor()	Resets the LoadingPageForeColor to the default value.
ResetLoadingPageSize()	Resets the LoadingPageSize to the default value.
ResetOutlineAreaBackColor()	Resets the OutlineAreaBackColor to the default value.
ResetOutlineBackColorHot()	Resets the OutlineBackColorHot to the default value.
ResetOutlineBackColorHotSelected()	Resets the OutlineBackColorHotSelected to the default value.
ResetOutlineBackColorNormal()	Resets the OutlineBackColorNormal to the default value.
ResetOutlineBackColorSelected()	Resets the OutlineBackColorSelected to the default value.
ResetOutlineButtonBackColorHot()	Resets the OutlineButtonBackColorHot to the default value.
ResetOutlineButtonBackColorNormal()	Resets the OutlineButtonBackColorNormal to the default value.
ResetOutlineButtonBackColorPressed()	Resets the OutlineButtonBackColorPressed to the default value.
ResetOutlineButtonBorderColorHot()	Resets the OutlineButtonBorderColorHot to the default value.
ResetOutlineButtonBorderColorNormal()	Resets the OutlineButtonBorderColorNormal to the default value.
ResetOutlineButtonBorderColorPressed()	Resets the OutlineButtonBorderColorPressed to the default value.
ResetOutlineButtonForeColorHot()	Resets the OutlineButtonForeColorHot to the default value.
ResetOutlineButtonForeColorNormal()	Resets the OutlineButtonForeColorNormal to the default value.
ResetOutlineButtonForeColorPressed()	Resets the OutlineButtonForeColorPressed to the default value.
ResetOutlineForeColorHot()	Resets the OutlineForeColorHot to the default value.
ResetOutlineForeColorHotSelected()	Resets the OutlineForeColorHotSelected to the default value.
ResetOutlineForeColorNormal()	Resets the OutlineForeColorNormal to the default value.
ResetOutlineForeColorSelected()	Resets the OutlineForeColorSelected to the default value.
ResetOutlineLineColor()	Resets the OutlineLineColor to the default value.
ResetPadding()	Resets the Padding to the default value.
ResetPageAreaBackColor()	Resets the PageAreaBackColor to the default value.
ResetPageAreaPadding()	Resets the PageAreaPadding to the default value.
ResetPageFillColor()	Resets the PageFillColor to the default value.
ResetPageOverpan()	Resets the PageOverpan to the default value.
ResetPageSpacing()	Resets the PageSpacing to the default value.
ResetPaginated()	Resets the Paginated property value.
ResetParamErrorForeColor()	Resets the ParamErrorForeColor to the default value.
ResetParamHeaderBackColor()	Resets the ParamHeaderBackColor to the default value.
ResetParamHeaderForeColor()	Resets the ParamHeaderForeColor to the default value.
ResetSearch()	Stops the search mode and removes highlighting from the found text fragments.
ResetSelectionHighlightColor()	Resets the SelectionHighlightColor to the default value.
ResetSplitterColor()	Resets the SplitterColor to the default value.
ResetThumbAreaBackColor()	Resets the ThumbAreaBackColor to the default value.
ResetThumbAreaPadding()	Resets the ThumbAreaPadding to the default value.
ResetThumbBackColorHot()	Resets the ThumbBackColorHot to the default value.
ResetThumbBackColorPressed()	Resets the ThumbBackColorPressed to the default value.
ResetThumbBackColorSelected()	Resets the ThumbBackColorSelected to the default value.
ResetThumbPadding()	Resets the ThumbPadding to the default value.
ResetThumbPageAreaBackColor()	Resets the ThumbPageAreaBackColor to the default value.
ResetThumbPageNumBackColor()	Resets the ThumbPageNumBackColor to the default value.
ResetThumbPageNumForeColor()	Resets the ThumbPageNumForeColor to the default value.
ResetThumbPageNumSize()	Resets the ThumbPageNumSize to the default value.
ResetThumbPagePreviewSize()	Resets the ThumbPagePreviewSize to the default value.
ResetZoomFactor()	Resets the ZoomFactor property to the default value.
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.
ShouldSerializeActiveFindMatchHighlightColor()	Tests whether the ActiveFindMatchHighlightColor property should be serialized.
ShouldSerializeContextMenuElements()	Indicates whether the ContextMenuElements property should be serialized.
ShouldSerializeCustomCursors()	Indicates whether the CustomCursors property should be serialized.
ShouldSerializeFindMatchHighlightColor()	Tests whether the FindMatchHighlightColor property should be serialized.
ShouldSerializeLinkOverpan()	Tests whether the LinkOverpan property should be serialized.
ShouldSerializeLoadingPageForeColor()	Tests whether the LoadingPageForeColor property should be serialized.
ShouldSerializeLoadingPageSize()	Tests whether the LoadingPageSize property should be serialized.
ShouldSerializeMiscStrings()	Indicates whether the MiscStrings property should be serialized.
ShouldSerializeOutlineAreaBackColor()	Tests whether the OutlineAreaBackColor property should be serialized.
ShouldSerializeOutlineBackColorHot()	Tests whether the OutlineBackColorHot property should be serialized.
ShouldSerializeOutlineBackColorHotSelected()	Tests whether the OutlineBackColorHotSelected property should be serialized.
ShouldSerializeOutlineBackColorNormal()	Tests whether the OutlineBackColorNormal property should be serialized.
ShouldSerializeOutlineBackColorSelected()	Tests whether the OutlineBackColorSelected property should be serialized.
ShouldSerializeOutlineButtonBackColorHot()	Tests whether the OutlineButtonBackColorHot property should be serialized.
ShouldSerializeOutlineButtonBackColorNormal()	Tests whether the OutlineButtonBackColorNormal property should be serialized.
ShouldSerializeOutlineButtonBackColorPressed()	Tests whether the OutlineButtonBackColorPressed property should be serialized.
ShouldSerializeOutlineButtonBorderColorHot()	Tests whether the OutlineButtonBorderColorHot property should be serialized.
ShouldSerializeOutlineButtonBorderColorNormal()	Tests whether the OutlineButtonBorderColorNormal property should be serialized.
ShouldSerializeOutlineButtonBorderColorPressed()	Tests whether the OutlineButtonBorderColorPressed property should be serialized.
ShouldSerializeOutlineButtonForeColorHot()	Tests whether the OutlineButtonForeColorHot property should be serialized.
ShouldSerializeOutlineButtonForeColorNormal()	Tests whether the OutlineButtonForeColorNormal property should be serialized.
ShouldSerializeOutlineButtonForeColorPressed()	Tests whether the OutlineButtonForeColorPressed property should be serialized.
ShouldSerializeOutlineForeColorHot()	Tests whether the OutlineForeColorHot property should be serialized.
ShouldSerializeOutlineForeColorHotSelected()	Tests whether the OutlineForeColorHotSelected property should be serialized.
ShouldSerializeOutlineForeColorNormal()	Tests whether the OutlineForeColorNormal property should be serialized.
ShouldSerializeOutlineForeColorSelected()	Tests whether the OutlineForeColorSelected property should be serialized.
ShouldSerializeOutlineLineColor()	Tests whether the OutlineLineColor property should be serialized.
ShouldSerializePadding()	Tests whether the Padding property should be serialized.
ShouldSerializePageAreaBackColor()	Tests whether the PageAreaBackColor property should be serialized.
ShouldSerializePageAreaPadding()	Tests whether the PageAreaPadding property should be serialized.
ShouldSerializePageFillColor()	Tests whether the PageFillColor property should be serialized.
ShouldSerializePageOverpan()	Tests whether the PageOverpan property should be serialized.
ShouldSerializePageSpacing()	Tests whether the PageSpacing property should be serialized.
ShouldSerializePaginated()	Indicates whether the Paginated property should be serialized.
ShouldSerializeParamErrorForeColor()	Tests whether the ParamErrorForeColor property should be serialized.
ShouldSerializeParamHeaderBackColor()	Tests whether the ParamHeaderBackColor property should be serialized.
ShouldSerializeParamHeaderForeColor()	Tests whether the ParamHeaderForeColor property should be serialized.
ShouldSerializeParameterStrings()	Indicates whether the ParameterStrings property should be serialized.
ShouldSerializeRibbonElements()	Indicates whether the RibbonElements property should be serialized.
ShouldSerializeRibbonGroups()	Indicates whether the RibbonGroups property should be serialized.
ShouldSerializeSearchBarElements()	Indicates whether the SearchBarElements property should be serialized.
ShouldSerializeSelectionHighlightColor()	Tests whether the SelectionHighlightColor property should be serialized.
ShouldSerializeSplitterColor()	Tests whether the SplitterColor property should be serialized.
ShouldSerializeStatusBarElements()	Indicates whether the StatusBarElements property should be serialized.
ShouldSerializeThumbAreaBackColor()	Tests whether the ThumbAreaBackColor property should be serialized.
ShouldSerializeThumbAreaPadding()	Tests whether the ThumbAreaPadding property should be serialized.
ShouldSerializeThumbBackColorHot()	Tests whether the ThumbBackColorHot property should be serialized.
ShouldSerializeThumbBackColorPressed()	Tests whether the ThumbBackColorPressed property should be serialized.
ShouldSerializeThumbBackColorSelected()	Tests whether the ThumbBackColorSelected property should be serialized.
ShouldSerializeThumbPadding()	Tests whether the ThumbPadding property should be serialized.
ShouldSerializeThumbPageAreaBackColor()	Tests whether the ThumbPageAreaBackColor property should be serialized.
ShouldSerializeThumbPageNumBackColor()	Tests whether the ThumbPageNumBackColor property should be serialized.
ShouldSerializeThumbPageNumForeColor()	Tests whether the ThumbPageNumForeColor property should be serialized.
ShouldSerializeThumbPageNumSize()	Tests whether the ThumbPageNumSize property should be serialized.
ShouldSerializeThumbPagePreviewSize()	Tests whether the ThumbPagePreviewSize property should be serialized.
ShouldSerializeToolBarElements()	Indicates whether the ToolBarElements property should be serialized.
ShouldSerializeZoomDialogStrings()	Indicates whether the ZoomDialogStrings property should be serialized.
ShouldSerializeZoomFactor()	Tests whether the ZoomFactor property should be serialized.
ShowZoomDialog()	Shows a modal dialog for adjusting Zoom and Layout options.

Events

Name	Description
ContextMenuPopup	Occurs when the user right-clicked C1FlexViewerPane 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.
LocationChanged	Occurs when the Location property value has changed.
LongOperation	Occurs periodically when a long operation is in progress.
MaximumSizeChanged	Occurs when the value of the MaximumSize property has changed.
MinimumSizeChanged	Occurs when the value of the MinimumSize property has changed.
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 C1FlexViewerPane that is not inherited from the base class changes.
SizeChanged	Occurs when the Size property value changes.
UserAction	Allows to provide non-standard action handling, or cancel the action.