AddViewStateToHistory メソッド (C1PreviewPane)

Creates a new ViewHistoryItem object with the specified ViewState.

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

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

シンタックス

Visual Basic
C#

'宣言
 
Public Function AddViewStateToHistory( _
   ByVal userAction As HistorySavedActionsEnum, _
   ByVal historyItemCaption As System.String, _
   ByVal viewState As ViewState _
) As ViewHistoryItem

'使用法
 
Dim instance As C1PreviewPane
Dim userAction As HistorySavedActionsEnum
Dim historyItemCaption As System.String
Dim viewState As ViewState
Dim value As ViewHistoryItem
 
value = instance.AddViewStateToHistory(userAction, historyItemCaption, viewState)

public ViewHistoryItem AddViewStateToHistory( 
   HistorySavedActionsEnum userAction,
   System.string historyItemCaption,
   ViewState viewState
)

パラメータ

userAction: The HistorySavedActionsEnum value defining user action associated with the new history item.
historyItemCaption: The caption of the new history item.
viewState: The ViewState structure representig the state of C1PreviewPane control (scroll position, zooming etc).

戻り値の型

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

参照

C1PreviewPane クラス
 C1PreviewPane メンバ