[]
        
(Showing Draft Content)

C1.Win.C1Preview.C1PreviewPane.AddViewStateToHistory

AddViewStateToHistory Method

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.

Declaration
public ViewHistoryItem AddViewStateToHistory(HistorySavedActionsEnum userAction, string historyItemCaption, ViewState viewState)
Parameters
Type Name Description
HistorySavedActionsEnum userAction

The HistorySavedActionsEnum value defining user action associated with the new history item.

string historyItemCaption

The caption of the new history item.

ViewState viewState

The ViewState structure representig the state of C1PreviewPane control (scroll position, zooming etc).

Returns
Type Description
ViewHistoryItem

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