PrintDocument for WinForms | ComponentOne
C1.Win.PrintPreview.4.8 Assembly / C1.Win.C1Preview Namespace / C1PreviewPane Class / AddCurrentViewStateToHistory Method
A HistorySavedActionsEnum value defining the user action associated with the new history item.
The caption of the new history item.
If true, forces adding of the current state even if it is equal to the state stored in the CurrentHistoryEntry.

In This Topic
    AddCurrentViewStateToHistory Method (C1PreviewPane)
    In This Topic
    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 HistoryOptions.SavedActions value of the current pane's HistoryOptions.

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

    Syntax
    'Declaration
     
    Public Function AddCurrentViewStateToHistory( _
       ByVal userAction As HistorySavedActionsEnum, _
       ByVal historyItemCaption As String, _
       ByVal force As Boolean _
    ) As ViewHistoryItem
    public ViewHistoryItem AddCurrentViewStateToHistory( 
       HistorySavedActionsEnum userAction,
       string historyItemCaption,
       bool force
    )

    Parameters

    userAction
    A HistorySavedActionsEnum value defining the user action associated with the new history item.
    historyItemCaption
    The caption of the new history item.
    force
    If true, forces adding of the current state even if it is equal to the state stored in the CurrentHistoryEntry.

    Return Value

    The newly created ViewHistoryItem object, or null if the action was cancelled.
    See Also