[]
        
(Showing Draft Content)

C1.Win.C1Preview.C1PreviewPane

C1PreviewPane Class

Represents the barebones control showing the preview of the associated document. To add functionality, other C1Preview components can be connected to this control.

Namespace: C1.Win.C1Preview
Assembly: C1.Win.PrintPreview.8.dll
Syntax
[ToolboxBitmap(typeof(C1PreviewPane), "C1PreviewPane.png")]
public class C1PreviewPane : Panel, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitialize

Constructors

Name Description
C1PreviewPane()

Initializes a new instance of C1PreviewPane control.

Properties

Name Description
BackColor

Gets or sets the background color for the control.

Busy

Gets or sets the flag indicating whether the preview 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 preview pane's properties or invoke methods on it.

CanSetPageSettings

Gets a value indicating whether the currently loaded document supports changing the page settings.

Cols

Gets or sets the number of page columns shown.

CompatibilityOptions

Gets the CompatibilityOptions object which determines compatibility with previous versions of C1PreviewPane.

ContextMenuStrip

Gets or sets the System.Windows.Forms.ContextMenuStrip associated with this C1PreviewPane. If not explicitly set in code (i.e. null at design time), the default context menu will be used at runtime.

Continuous

Gets or sets a value indicating whether to show document pages continuously.

CurrentHistoryEntry

Gets or sets the current history entry.

Assigning to this property moves the preview pane in history. The value being assigned must be an element in the ViewHistory collection.

Note that in some situations the current history entry can not be changed (e.g. when the operation is attempted while the preview is changing its state). In those cases the set operation will be ignored.

CurrentHistoryEntryIndex

Gets or sets the index of current history entry.

Assigning to this property moves the preview pane in history.

Note that in some situations the current history entry can not be changed (e.g. when the operation is attempted while the preview is changing its state). In those cases the set operation will be ignored.

CurrentVisitedDocument

Gets or sets the current visited document.

CurrentVisitedDocumentIndex

Gets or sets the index of the current visited document in the VisitedDocuments collection.

Assigning a value to this property causes the preview pane to show the document stored at that index in the collection. If the assigned value is -1, the current document is cleared.

Document

Gets or sets the document shown by the preview.

DpiX

Gets the horizontal resolution of the display.

DpiY

Gets the vertical resolution of the display.

ExportOptions

Gets the options controlling the behavior of export modules.

HandleKeyboard

Gets or sets a value indicating whether the C1PreviewPane should handle the common preview keys.

HasSelection

Gets a value indicating whether anything is selected in the current preview pane.

HideMargins

Gets or sets a value indicating whether the user is allowed to hide/show margins by double-clicking the mouse in the gap between pages.

HideMarginsAvail

Gets a value indicating whether horizontal or vertical margins can be hidden on the current document. Margins can hide if all pages have the same size. Additionally, horizontal margins can also hide if the preview has one column.

HideMarginsState

Gets or sets a value indicating whether horizontal and/or vertical margins should be hidden.

HistoryOptions

Gets the HistoryOptions object determining how history is saved for the current C1PreviewPane.

HorzPageRulerRectangle

Gets the rectangle for the horizontal ruler for the current page, in client coordinates. The actual visible ruler can be clipped by the HorzRulerArea.

HorzRulerArea

Gets the horizontal ruler area (the actual ruler is always contained within that area).

IntegrateExternalTools

Gets or sets a value indicating whether the current preview pane should integrate and handle external tools such as toolbars and navigation panels. When true, the ToolsIntegrator can be used to access the tools associated with the current preview pane.

IsHistoryLocked

Gets a value indicating whether history is currently locked (i.e. adding of new history items is suspended).

KeyMapStack

Gets the KeyMapStack containing key maps for keyboard handling.

MaxZoomFactor

Gets or sets the maximum allowed zoom factor.

MinZoomFactor

Gets or sets the minimum allowed zoom factor.

MouseMode

Gets or sets the mouse mode (zoom, selection etc.).

PageLayout

Gets or sets the preview layout.

PageSettings

Gets or sets page settings associated with the current document.

IMPORTANT NOTE: The PageSettings object returned by this property is created on the fly, and any changes made to its sub-properties may be lost unless you explicitly assign the modified object to the current property.

Pages

Gets the collection of the preview pages.

PagesFillColor

Gets or sets the color used to fill the document pages in the preview before drawing the content.

PagesFitPaper

Gets the value indicating whether the document pages have the same size as the currently selected printer paper.

PagesPadding

Gets or sets the amount of padding between pages in the preview.

PagesPaddingCurr

Gets the current padding between pages in the preview.

PagesPaddingSmall

Gets or sets the amount of padding between pages in the preview used when margins are hidden.

PreviewCursors

Gets the set of cursors used in the preview.

PreviewRectangle

Gets the preview rectangle (client are of the preview pane without the rulers and scrollbars).

PreviewScrollPosition

Gets or sets the location of the top left corner of the preview area (the scroll position) within the preview window. The value is relative to the PreviewRectangle, not to the ClientRectangle. The value is independent of the ZoomFactor (i.e. setting the same values will scroll to the same logical position in the document at any zoom factor).

PrintOptions

Gets the print options.

PrintPreviewControl

Gets the C1PrintPreviewControl containing the current C1PreviewPane, or null.

PrinterSettings

Gets or sets printer settings.

PrintingLayout

Gets or sets a value indicating whether to show the physical printing layout (printer page size and the location of the document pages' on the paper).

Reflowable

Gets the value indicating whether the currently loaded document supports reflow.

RestrictScrollToPage

Gets or sets a value indicating whether scrolling with the scrollbar or mouse wheel is restricted to the current page (for non-continuous mode only).

The default is false.

Rows

Gets or sets the number of page rows shown in non-continuous mode.

RulerUnits

Gets or sets a value specifying what measurement units should be used by the rulers. By default the units are determined by the current country/region.

ScaleChildren

For internal use.

ShowPageOutline

Gets or sets a value indicating whether to show the original page outline (as a dashed line) when PrintingLayout is true and the printer paper does not match the original page size.

ShowPrintProgressDialog

Gets or sets a value indicating whether to show a cancellable print progress dialog while printing a document. If this property is false (which is the default), only a status progress bar shows print progress (and so printing cannot be cancelled).

ShowPrintableArea

Gets or sets a value indicating whether to highlight the printable area of the current printer.

ShowRulers

Gets or sets a value indicating whether to show horizontal and/or vertical rulers.

ShowToolTips

Gets or sets a value indicating whether to show tooltips.

SidesPadding

Gets or sets the amount of padding between pages and the preview window edges.

StartPageIdx

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.

StatusText

Gets or sets the string that is interpreted by attached controls as the current status string.

ToolTip

Gets the ToolTip used to display tooltips in the preview. Change this to customize the way preview tooltips look (e.g. change colors etc.).

ToolsIntegrator

Gets the C1PreviewToolsIntegrator used by the current preview pane. Provides access to controls associated with the current preview pane, such as C1PreviewThumbnailView and C1PreviewOutlineView. This value is null if IntegrateExternalTools is false.

TrackMousePosition

Gets or sets a value indicating whether the rulers should display marks showing the current cursor position.

VertPageRulerRectangle

Gets the rectangle for the vertical ruler for the current page, in client coordinates. The actual visible ruler can be clipped by the VertRulerArea.

VertRulerArea

Gets the vertical ruler area (the actual ruler is always contained within that area).

ViewHistory

Gets the collection of ViewHistoryItem objects saved in history. Depending on HistoryOptions, items are automatically added to this collection when the user scrolls, zooms and so on in the current C1PreviewPane.

VisitedDocuments

Gets the collection of VisitedDocument objects saved in history. If HistoryOptions indicates that documents should be saved in history, they are added to this collection automatically when the user navigates between documents.

ZoomFactor

Gets or sets the zoom factor (1 is actual size).

ZoomMode

Gets or sets the preview zoom mode.

ZoomSteps

Gets or sets the array of preset zoom factors.

Methods

Name Description
AddCurrentViewStateToHistory(HistorySavedActionsEnum, string, bool)

Creates a new ViewHistoryItem object using the current state of the C1PreviewPane.

The newly created object is then added to the ViewHistory collection. Adding of the new state to history is cancelled if the Document property of the current preview pane is null, or if the specified action should not be saved according to the SavedActions value of the current pane's HistoryOptions.

Adding of the new state to history can also be cancelled in the HistoryItemAdding event.

AddViewStateToHistory(HistorySavedActionsEnum, string, ViewState)

Creates a new ViewHistoryItem object with the specified ViewState.

The newly created object is then added to the ViewHistory collection.

Adding of the new state to history can be cancelled in the HistoryItemAdding event.

ClientToDocument(Point, out int, out PointF)

Converts a point in the current C1PreviewPane's client coordinates, to document coordinates.

Document coordinates are also pixels, but are relative to a specific page's left top corner, and do not depend on the current zoom factor.

For instance, a client point that is over a page's right top corner would yield a point with document coordinates (816,0) on a 96 DPI resolution display for a 8.5 in wide page (816 is 8.5 multiplied by 96), regardless of the current zoom factor or document scroll position in the preview.

CopySelectionToClipboard()

Copies the text currently selected in this C1PreviewPane to clipboard. Does nothing if the current selection is empty.

Dispose(bool)

Releases the resoureces used by C1PreviewPane.

DoCopySelection()

Copies the current selection to clipboard.

DoEscape()

Handles the Escape key (clears selection, resets mouse mode).

DoGoHistoryBack()

Goes back in history.

DoGoHistoryForward()

Goes forward in history.

DoGoNextPage()

Goes to next page.

DoGoPreviousPage()

Goes to previous page.

DoScrollBottom()

Scrolls to the end of the document.

DoScrollDown()

Scrolls down.

DoScrollLeft()

Scrolls left.

DoScrollPageDown()

Scrolls one page down.

DoScrollPageUp()

Scrolls one page up.

DoScrollRight()

Scrolls right.

DoScrollTop()

Scrolls to the top of the document.

DoScrollUp()

Scrolls up.

DoSelectAll()

Selects the whole document.

DoZoomIn()

Zooms in.

DoZoomOut()

Zooms out.

DocumentToClient(int, PointF)

Converts a PointF in document coordinates to the current C1PreviewPane's client coordinates.

DocumentToClient(int, PointF, out Point)

Converts a PointF in document coordinates to the current C1PreviewPane's client coordinates.

DocumentToClient(int, RectangleF)

Converts a RectangleF in document coordinates to the current C1PreviewPane's client coordinates.

DocumentToClient(int, RectangleF, out Rectangle)

Converts a RectangleF in document coordinates to the current C1PreviewPane's client coordinates.

FileOpen()

Shows a file open dialog, allows the user to select a C1DX or C1D file, and loads the selected file into the current preview pane. If an exception occurs while loading the file, an error message is displayed, and the method returns false.

FileOpen(string)

Loads the specified file (which must be a valid C1DX, C1D or C1MDX document) into the current preview pane.

If fileName does not exist or is a directory, shows the file open dialog and allows the user to select a file to load. In that case fileName specifies the initial directory for the dialog.

FileSave()

Saves the currently loaded document, allowing the user to select the file name and the output format, using the ExportOptions specified on the current preview pane.

FileSave(string, ExportProvider)

Saves the currently loaded document into the specified fileName. If fileName is null or empty, or if exportProvider is null, shows the file save dialog allowing the user to select the file name and output format.

ExportOptions specified on the current preview pane are used when saving the document.

Searches for a hyperlink at the specified client location.

GetPagePreviewRect(int)

Gets the rectangle representing the specified page, relative to PreviewScrollPosition. The rectangle is in document coordinates (i.e. does not depend on the current zoom factor).

GetPageSize(int)

Gets the size of a page specified by the page index. The size is in document coordinates (i.e. does not depend on the current zoom factor).

GetPageVisibility(int)

Gets the percentage (from 0 to 100) of the area of the specified page that is currently visible in this C1PreviewPane. The returned value is rounded to 2 decimal digits.

GetPageVisibleArea(int)

Gets RectangleF representing the area of the specified page that is currently visible in the current C1PreviewPane. The rectangle is in document (i.e. independent of the current zoom factor) coordinates, and is relative to the specified page's left top corner.

GetSelectedText()

Gets the text currently selected in this C1PreviewPane.

GoToSelection()

Makes sure that the currently selected text is visible in the current C1PreviewPane. (This method does nothing if currently there is no selection.)

GotoAnchor(string)

Ensures that the specified anchor (see C1Anchor) is visible in the current preview pane.

GotoDocumentLocation(IDocumentLocation)

Ensures that the specified document location is visible in the current preview pane.

GotoDocumentLocation(IDocumentLocation, string)

Ensures that the specified document location is visible in the current preview pane.

HistoryBack()

Goes back in history.

HistoryForward()

Goes forward in history.

IsPageVisible(int)

Gets a value indicating whether any part of the specified page is currently visible in this C1PreviewPane.

LockHistory()

Temporarily locks (suspends) adding of new items to ViewHistory. Note a matching call to UnlockHistory(HistorySavedActionsEnum, string) must exist for each call of this method.

MakeClientVisible(Point)

Ensures that the specified point (expressed in preview pane client coordinates) is visible (scrolled in) in the preview pane.

MakeClientVisible(Rectangle)

Ensures that the specified rectangle (expressed in preview pane client coordinates) is visible (scrolled in) in the preview pane.

OnLayout(LayoutEventArgs)

Overridden. Raises the Layout event.

OnLongOperation(LongOperationEventArgs)

Raises the LongOperation event on the preview pane.

OnLongOperation(double, bool)

Raises the LongOperation event on the preview pane.

OnMouseClick(MouseEventArgs)

Overridden. Raises the MouseClick event.

OnMouseDoubleClick(MouseEventArgs)

Overridden. Raises the MouseDoubleClick event.

OnMouseDown(MouseEventArgs)

Overridden. Raises the MouseDown event.

OnMouseMove(MouseEventArgs)

Overridden. Raises the MouseMove event.

OnMouseUp(MouseEventArgs)

Overridden. Raises the MouseUp event.

OnMouseWheel(MouseEventArgs)

Overridden. Raises the MouseWheel event.

OnPaint(PaintEventArgs)

Overridden. Raises the Paint event.

OnParentChanged(EventArgs)

Overridden. Raises the ParentChanged event.

OnPreviewPrint(PreviewPrintEventArgs)

Raises the PreviewPrint event on the current preview pane.

OnPropertyChanged(string)

Raises the PropertyChanged event.

OnSizeChanged(EventArgs)

Overridden. Raises the SizeChanged event.

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.

Print(string, int[])

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

Reflow()

Reflows the currently loaded document.

ResetBackColor()

Resets the BackColor property to the default value.

ResetCompatibilityOptions()

Resets the CompatibilityOptions property to the defalut value.

ResetPagesFillColor()

Resets the PagesFillColor to the default value.

ResetPagesPadding()

Resets the PagesPadding to the default value.

ResetPagesPaddingSmall()

Resets the PagesPaddingSmall to the default value.

ResetSidesPadding()

Resets the SidesPadding to the default value.

ResetZoomFactor()

Resets the ZoomFactor property to the default value.

ResetZoomSteps()

Resets the ZoomSteps property to the default value.

ScrollClient(int, int)

Scrolls the previewed document in the client area by the specified horizontal and vertical amounts. May change the currently shown row of pages.

ScrollClient(int, int, bool)

Scrolls the previewed document in the client area by the specified horizontal and vertical amounts.

ScrollPreview(float, float)

Scrolls the previewed document in the client area by the specified horizontal and vertical amounts. The scroll amounts are expressed in document coordinates. May change the currently shown row of pages.

ScrollPreview(float, float, bool)

Scrolls the previewed document in the client area by the specified horizontal and vertical amounts. The scroll amounts are expressed in document coordinates.

SelectAll()

Selects all text in the document currently loaded into this C1PreviewPane.

SelectPage(int)

Selects all text on the specified page in the document currently loaded into this C1PreviewPane.

SelectTextFragment(C1TextFragment)

Selects the specified text fragment in the document currently loaded in the current C1PreviewPane.

SelectWord(Point)

Selects a word at the specified location (in client coordinates) in the document currently loaded into this C1PreviewPane.

SelectionClear()

Removes all selection in the document currently loaded into this C1PreviewPane.

SetFocus(RenderInputFragment)

Sets the input focus to the specified RenderInputFragment object. This method should be used only if the preview currently shows a C1PrintDocument.

ShouldSerializeBackColor()

Tests whether the BackColor property should be serialized.

ShouldSerializeCompatibilityOptions()

Indicates whether the CompatibilityOptions property should be serialized.

ShouldSerializeExportOptions()

Indicates whether the ExportOptions property should be serialized.

ShouldSerializePagesFillColor()

Tests whether the PagesFillColor property should be serialized.

ShouldSerializePagesPadding()

Tests whether the PagesPadding property should be serialized.

ShouldSerializePagesPaddingSmall()

Tests whether the PagesPaddingSmall property should be serialized.

ShouldSerializeSidesPadding()

Tests whether the SidesPadding property should be serialized.

ShouldSerializeZoomFactor()

Tests whether the ZoomFactor property should be serialized.

ShouldSerializeZoomSteps()

Tests whether the ZoomSteps property should be serialized.

ShowErrorMessage(Exception)

Shows a dialog box with the exception message.

TextSearch(C1TextSearchArgs)

Searches for an occurrence of a text in the document currently loaded in the current C1PreviewPane.

TextSearchAll(C1TextSearchArgs)

Searches for all occurrences of a text in the document currently loaded in the current C1PreviewPane.

UnlockHistory(HistorySavedActionsEnum, string)

Unlocks (resumes) adding of new items to ViewHistory temporarily locked by a previous call to LockHistory().

UpdatePreview()

Forces the preview pane to update the preview.

WndProc(ref Message)

Overridden. Processes Windows messages.

Events

Name Description
AdjustPrintPage

Fired from within the PrintPage event handler of the C1PrintManager used to print the document. See AdjustPrintPage for details.

Error

Occurs when an external exception is thrown (e.g. while printing).

FormsUserAction

Occurs when user performs some action on RenderInputBase object within preview (Click, MouseDown etc).

HistoryItemAdding

Occurs when a new ViewHistoryItem object is being added to the ViewHistory collection. The event handler can cancel this adding.

HyperlinkJump

Occurs when a hyperlink jump takes place.

HyperlinkMouseDown

Occurs when the mouse pointer is over a hyperlink and a mouse button is pressed.

HyperlinkMouseEnter

Occurs when the mouse pointer enters a hyperlink.

HyperlinkMouseLeave

Occurs when the mouse pointer leaves a hyperlink.

HyperlinkMouseMove

Occurs when the mouse pointer moves over a hyperlink.

HyperlinkMouseUp

Occurs when the mouse pointer is over a hyperlink and a mouse button is released.

LoadVisitedDocument

Occurs if VisitedDocumentStorage on the current preview pane is set to User, and a previously saved visited document should be loaded from history.

LongOperation

Occurs periodically when a long operation is in progress.

PreviewAction

Occurs when the document action from preview forms should be executed.

PreviewPrint

Occurs immediately before a print dialog is shown by the preview in response to user action. Allows to adjust the properties of the print dialog, or cancel it without showing.

PropertyChanged

Occurs when a property of the preview pane that is not inherited from the base class changes.

QueryPageSettings

Fired from within the QueryPageSettings event handler of the C1PrintManager used to change page settings. See QueryPageSettings for details.

SaveVisitedDocument

Occurs if VisitedDocumentStorage on the current preview pane is set to User, and a visited document should be added to history. The event handler must save the document.

UserAction

Occurs whenever the user clicks one of the predefined preview toolbar buttons such as print or file open. Allows to provide non-standard toolbar button handling, or cancel the action.

UserHyperlinkJump

Occurs when a user-defined hyperlink jump takes place.

VisitedDocumentAdding

Occurs when a new VisitedDocument object is being added to the VisitedDocuments collection of the current preview pane. Adding can be cancelled in the event handler.