スクリプトマニュアル

新しいブックマークフォルダーを作成して追加する

パラメーター

parameter

dictionary

新しいブックマークフォルダーのパラメーター (省略可)
パラメーター "Name" を指定できます。

戻り値

新しいブックマークフォルダー

例

// Create a bookmark folder by name
nv.Bookshelf.FolderTree.BookmarkNode.Add({Name:"AAA"})

Insert(int, dictionary)

新しいブックマークフォルダーを作成して挿入する

パラメーター

index	int	無効なパラメーター注意: ブックマークフォルダーでは順番を制御できないため、このパラメーターは無視されます。
parameter	dictionary	新しいブックマークフォルダーのパラメーター (省略可) パラメーター "Name" を指定できます。

戻り値

新しいブックマークフォルダー

Remove()

bool

自身を削除する

戻り値

bool	削除に成功したら "true"

[Class] BookmarkFolderNodeSource

ブックマークフォルダーのプロパティ

プロパティ

Name	string	rw	名前
Path	string	r	ブックマークフォルダーのパス

[Class] BookmarkFolderTreeAccessor

ブックマークフォルダーツリーのアクセサ

プロパティ

BookmarkNode	BookmarkFolderNodeAccessor	r	ブックマークフォルダーツリーのルートノード
SelectedItem	NodeAccessor	rw	選択項目

[Class] BookmarkItemAccessor

ブックマークパネル項目

プロパティ

CreationTime	Date	r	作成日時
LastWriteTime	Date	r	更新日時
Name	string	r	名前
Path	string	r	パス
Size	int	r	ファイルサイズ。ディレクトリのときは -1

メソッド

Open()

void

ブックを開く

Open(bool)

void

ブックを開く

パラメーター

isRecursive

bool

サブフォルダーを読み込む

[Class] BookmarkPanelAccessor

ブックマークパネルのアクセサ

プロパティ

FolderOrder	string (FolderOrder)	rw	リスト項目並び順
FolderTree	BookmarkFolderTreeAccessor	r	ブックマークパネルのフォルダーツリー
IsFloating	bool	r	パネルのフローティング状態
IsSelected	bool	rw	パネル選択状態
IsVisible	bool	r	パネル表示状態
Items	BookmarkItemAccessor[]	r	リスト項目
Path	string	rw	現在のブックマークフォルダーのパス
SearchWord	string	rw	検索ボックスのテキスト
SelectedItems	BookmarkItemAccessor[]	rw	選択されているリスト項目
Style	string (PanelListItemStyle)	rw	リスト項目表示形式

メソッド

Close()

void

パネルを閉じる

MoveToParent()

void

上に移動

NewFolder(string)

void

新しいブックマークフォルダーを作成する

パラメーター

name

string

名前

Open()

void

パネルを開く

OpenDock()

void

ドッキング状態でパネルを開く

OpenFloat()

void

フローティング状態でパネルを開く

[Class] BookshelfFolderTreeAccessor

本棚のフォルダーツリーのアクセサ

プロパティ

BookmarkNode	BookmarkFolderNodeAccessor	r	ブックマークフォルダーツリーのルートノード
DirectoryNode	DirectoryNodeAccessor	r	フォルダーツリーのルートノード
QuickAccessNode	QuickAccessFolderNodeAccessor	r	クイックアクセスのルートノード
SelectedItem	NodeAccessor	rw	選択項目

メソッド

Expand(string)

void

指定フォルダーまで展開する

パラメーター

path

string

フォルダーのパス

[Class] BookshelfItemAccessor

本棚パネル項目

プロパティ

CreationTime	Date	r	作成日時
LastWriteTime	Date	r	更新日時
Name	string	r	名前
Path	string	r	パス
Size	int	r	ファイルサイズ。ディレクトリのときは -1

メソッド

Open()

void

ブックを開く

Open(bool)

void

ブックを開く

パラメーター

isRecursive

bool

サブフォルダーを読み込む

[Class] BookshelfPanelAccessor

本棚パネルのアクセサです。

プロパティ

FolderOrder	string (FolderOrder)	rw	リスト項目並び順
FolderTree	BookshelfFolderTreeAccessor	r	本棚のフォルダーツリー
IsFloating	bool	r	パネルのフローティング状態
IsSelected	bool	rw	パネル選択状態
IsVisible	bool	r	パネル表示状態
Items	BookshelfItemAccessor[]	r	リスト項目
NextHistory	string[]	r	本棚での後の履歴
Path	string	rw	現在の本棚のパス
PreviousHistory	string[]	r	本棚での前の履歴
SearchWord	string	rw	検索ボックスのテキスト
SelectedItems	BookshelfItemAccessor[]	rw	選択されているリスト項目
Style	string (PanelListItemStyle)	rw	リスト項目表示形式

メソッド

Close()	void	パネルを閉じる
MoveToNext()	void	進む
MoveToParent()	void	上に移動
MoveToPrevious()	void	戻る
Open()	void	パネルを開く
OpenDock()	void	ドッキング状態でパネルを開く
OpenFloat()	void	フローティング状態でパネルを開く
Sync()	void	表示中のブックのある場所に移動
Wait()	void	表示が完了するまで待機する

[Class] CommandAccessor

コマンドアクセサ

プロパティ

IsShowMessage	bool	rw	コマンド実行時にメッセージを表示する
MouseGesture	string	rw	マウスジェスチャー例 `// Set "↑←↓" to the mouse gesture of ViewRotateLeft command nv.Command.ViewRotateLeft.MouseGesture = "ULD"`
Name	string	r	コマンド名
Parameter	dictionary	r	コマンドパラメーターの取得、設定ができます。設定は恒久的なものです。プロパティはコマンドごとに異なります。詳細は後述のコマンド一覧を確認してください。例 `// Change the rotation amount of "ViewRotateLeft" command to 45 degrees nv.Command.ViewRotateLeft.Parameter.Angle = 45`
ShortCutKey	string	rw	ショートカット例 `// Set "Ctrl+A" as shortcut for ViewRotateLeft command nv.Command.ViewRotateLeft.ShortCutKey = "Ctrl+A"`
TouchGesture	string	rw	タッチ操作例 `// Set "TouchCenter" for touch operation of ViewRotateLeft command nv.Command.ViewRotateLeft.TouchGesture = "TouchCenter"`

メソッド

Execute(object[])

bool

コマンドを実行します。
引数を指定可能なコマンドがあります。これらは通常はダイアログが表示されるコマンドで引数を指定することでユーザーの選択を省略するといった用途に使用できます。

パラメーター

args

object[]

コマンド引数。コマンドによって内容は異なります。可変長引数です。(省略可)

戻り値

bool	コマンドが発行できたか。ロード中などにコマンドが発行できないことがある。コマンド自体の成否は判別しない。

例

// open C:\Foo\Bar.zip
nv.Command.LoadAs.Execute("C:\\Foo\\Bar.zip")

Patch(dictionary)

CommandAccessor

一時的にコマンドパラーメーターを変更します。

パラメーター

patch

dictionary

一時的に上書きするコマンドパラメーターをJSON形式で指定します。

戻り値

CommandAccessor

自身のコマンドアクセサをそのまま返す

例

// Rotate counterclockwise by specifying 5 degrees
nv.Command.ViewRotateLeft.Patch({"Angle": 5}).Execute()

[Class] DestinationFolderAccessor

保存先フォルダーのアクセサ

プロパティ

Name	string	rw	名前
Path	string	rw	パス

メソッド

Copy(string)

void

保存先フォルダーにコピーする

パラメーター

path

string

コピーするファイル

Copy(string[])

void

保存先フォルダーにコピーする

パラメーター

paths

string[]

コピーするファイルのリスト

CopyPage(PageAccessor)

void

保存先フォルダーにコピーする

パラメーター

page

コピーするページ

CopyPage(PageAccessor[])

void

保存先フォルダーにコピーする

パラメーター

pages

PageAccessor[]

コピーするページのリスト

Move(string)

void

保存先フォルダーに移動する

パラメーター

path

string

移動するファイル

Move(string[])

void

保存先フォルダーに移動する

パラメーター

paths

string[]

移動するファイルのリスト

MovePage(PageAccessor)

void

保存先フォルダーに移動する

パラメーター

page

DestinationFolderAccessor[]

移動するページ

MovePage(PageAccessor[])

void

保存先フォルダーに移動する

パラメーター

pages

PageAccessor[]

移動するページのリスト

[Class] DestinationFolderCollectionAccessor

保存先フォルダーリストのアクセサ

プロパティ

Items

保存先フォルダーのリスト

メソッド

CreateNew()

DestinationFolderAccessor

新しい保存先フォルダーを作成する

戻り値

DestinationFolderAccessor

新しい保存先フォルダー

Remove(DestinationFolderAccessor)

void

保存先フォルダーを削除する

パラメーター

item

DestinationFolderAccessor

削除する保存先フォルダー

[Class] DirectoryNodeAccessor

フォルダーノードのアクセサ

このクラスは NodeAccessor を継承しています。

プロパティ

Children	NodeAccessor[]	r	子ノード
Index	int	r	インデックス番号
IsDisposed	bool	r	破棄されたノードならば "true"
IsExpanded	bool	rw	ノードが展開状態であれば "true"
Name	string	r	ノードの名前
Parent	NodeAccessor	r	親ノード
Value	DirectoryNodeSource	r	フォルダーノードのプロパティ
ValueType	string	r	ノードの値の型

[Class] DirectoryNodeSource

フォルダーノードのプロパティ

プロパティ

Name	string	r	名前
Path	string	r	パス

[Class] EffectPanelAccessor

エフェクトパネルのアクセサ

プロパティ

IsFloating	bool	r	パネルのフローティング状態
IsSelected	bool	rw	パネル選択状態
IsVisible	bool	r	パネル表示状態

メソッド

Close()	void	パネルを閉じる
Open()	void	パネルを開く
OpenDock()	void	ドッキング状態でパネルを開く
OpenFloat()	void	フローティング状態でパネルを開く

[Class] EnvironmentAccessor

環境アクセサ

プロパティ

DateVersion	string	r	日時バージョン
NeeViewPath	string	r	NeeView 実行ファイルのパス
OSVersion	string	r	OS バージョン
PackageType	string	r	パッケージの種類
ProductVersion	string	r	製品バージョン
Revision	string	r	Git リビジョン
SelfContained	bool	r	自己完結型パッケージ。false のときはフレームワーク依存型
UserAgent	string	r	ユーザーエージェント
UserSettingFilePath	string	r	設定ファイルのパス
Version	string	r	バージョン

[Class] ExternalAppAccessor

外部アプリのアクセサ

プロパティ

ArchivePolicy	string (ArchivePolicy)	rw	圧縮ファイルの処理方針
Command	string	rw	外部アプリのパス
Name	string	rw	表示名
Parameter	string	rw	外部アプリのパラメーター
WorkingDirectory	string	rw	作業フォルダー

メソッド

Execute(PageAccessor)

void

外部アプリを実行する

パラメーター

page

送るページ

Execute(PageAccessor[])

void

外部アプリを実行する

パラメーター

pages

PageAccessor[]

送るページのリスト

Execute(string)

void

外部アプリを実行する

パラメーター

path

string

送るファイル

Execute(string[])

void

外部アプリを実行する

パラメーター

paths

string[]

送るファイルのリスト

[Class] ExternalAppCollectionAccessor

外部アプリリストのアクセサ

プロパティ

Items

ExternalAppAccessor[]

外部アプリリスト

メソッド

CreateNew()

ExternalAppAccessor

新しい外部アプリを作成する

戻り値

ExternalAppAccessor

新しい外部アプリ

Remove(ExternalAppAccessor)

void

外部アプリを削除する

パラメーター

item

ExternalAppAccessor

削除する外部アプリ

[Class] HistoryItemAccessor

履歴項目のアクセサ

プロパティ

LastAccessTime	Date	r	最後にアクセスした日時
Name	string	r	項目名
Path	string	r	項目に対応するパス

メソッド

Open()

void

ブックを開く

[Class] HistoryPanelAccessor

履歴パネルのアクセサ

プロパティ

IsFloating	bool	r	パネルのフローティング状態
IsSelected	bool	rw	パネル選択状態
IsVisible	bool	r	パネル表示状態
Items	HistoryItemAccessor[]	r	リスト項目
SearchWord	string	rw	検索ボックスのテキスト
SelectedItems	HistoryItemAccessor[]	rw	選択されているリスト項目
Style	string (PanelListItemStyle)	rw	リスト項目表示形式

メソッド

Close()	void	パネルを閉じる
Open()	void	パネルを開く
OpenDock()	void	ドッキング状態でパネルを開く
OpenFloat()	void	フローティング状態でパネルを開く

[Class] InformationPanelAccessor

情報パネルのアクセサ

プロパティ

IsFloating	bool	r	パネルのフローティング状態
IsSelected	bool	rw	パネル選択状態
IsVisible	bool	r	パネル表示状態

メソッド

Close()	void	パネルを閉じる
Open()	void	パネルを開く
OpenDock()	void	ドッキング状態でパネルを開く
OpenFloat()	void	フローティング状態でパネルを開く

[Class] MediaPlayerAccessor

メディアプレイヤーのアクセサ

プロパティ

AudioTrack	TrackCollectionAccessor	r	オーディオトラック管理。存在しなければ null
Duration	double	r	メディアの再生時間 (秒)
IsMuted	bool	rw	消音モード ON/OFF
IsPlaying	bool	rw	再生 ON/OFF
IsRepeat	bool	rw	繰り返しモード ON/OFF
Position	double	rw	現在位置 (0.0-1.0)
Subtitle	TrackCollectionAccessor	r	字幕トラック管理。存在しなければ null
Volume	double	rw	音量 (0.0-1.0)

[Class] NavigatorPanelAccessor

ナビゲーターパネルのアクセサ

プロパティ

IsFloating	bool	r	パネルのフローティング状態
IsSelected	bool	rw	パネル選択状態
IsVisible	bool	r	パネル表示状態

メソッド

Close()	void	パネルを閉じる
Open()	void	パネルを開く
OpenDock()	void	ドッキング状態でパネルを開く
OpenFloat()	void	フローティング状態でパネルを開く

[Class] NodeAccessor

ノードのアクセサ

プロパティ

Children	NodeAccessor[]	r	子ノード
Index	int	r	インデックス番号
IsDisposed	bool	r	破棄されたノードならば "true"
IsExpanded	bool	rw	ノードが展開状態であれば "true"
Name	string	r	ノードの名前
Parent	NodeAccessor	r	親ノード
Value	object	r	ノードの値
ValueType	string	r	ノードの値の型

メソッド

Add(dictionary)

新しい項目を作成して追加する

パラメーター

parameter

dictionary

新しい項目のパラメーター (省略可)
連想配列でパラメーターを指定します。作成する項目の種類に依存するので、詳細は派生クラスの説明を参照してください。

戻り値

新しい項目

Insert(int, dictionary)

新しい項目を作成して挿入する

パラメーター

index	int	挿入位置
parameter	dictionary	新しい項目のパラメーター (省略可) 連想配列でパラメーターを指定します。作成する項目の種類に依存するので、詳細は派生クラスの説明を参照してください。

戻り値

新しい項目

MoveTo(int)

void

インデックス位置を変更する

パラメーター

newIndex

int

新しいインデックス番号

Remove()

bool

自身を削除する

戻り値

bool	削除に成功したら "true"

[Class] PageAccessor

ページアクセサ。ページ情報にアクセスします。

プロパティ

CreationTime	Date	r	作成日時
Index	int	r	ページインデックス。数字は 0 から始まる。
IsBook	bool	r	ブックとして開くことができる
LastWriteTime	Date	r	更新日時
Path	string	r	ページのパス
RawPath	string	r	未加工のパス
Size	int	r	ファイルサイズ (Byte)

メソッド

GetMetaValue(string)

string

ページのメタ情報を得る

パラメーター

key

string

メタ情報の項目名。詳細は検索オプションのヘルプを参照してください。

戻り値

string

メタ情報の値

GetMetaValueMap()

dictionary

ページのメタ情報一覧を得る

戻り値

dictionary

ページのメタ情報の連想配列

Open()

void

ページを開く

OpenAsBook()

void

ブックとして開く

[Class] PageListPanelAccessor

ページリストパネルのアクセサ

プロパティ

Format	string (PageNameFormat)	rw	項目名フォーマット
IsFloating	bool	r	パネルのフローティング状態
IsSelected	bool	rw	パネル選択状態
IsVisible	bool	r	パネル表示状態
Items	PageAccessor[]	r	リスト項目
Path	string	r	現在のブックのパス
SearchWord	string	rw	検索ボックスのテキスト
SelectedItems	PageAccessor[]	rw	選択されているリスト項目
SortMode	string (PageSortMode)	rw	リスト項目並び順
Style	string (PanelListItemStyle)	rw	リスト項目表示形式

メソッド

Close()	void	パネルを閉じる
Open()	void	パネルを開く
OpenDock()	void	ドッキング状態でパネルを開く
OpenFloat()	void	フローティング状態でパネルを開く

[Class] PlaylistItemAccessor

プレイリスト項目のアクセサ

プロパティ

Name	string	r	項目名
Path	string	r	項目に対応するパス

メソッド

Open()

void

項目を開く

[Class] PlaylistPanelAccessor

プレイリストパネルのアクセサ

プロパティ

IsFloating	bool	r	パネルのフローティング状態
IsSelected	bool	rw	パネル選択状態
IsVisible	bool	r	パネル表示状態
Items	PlaylistItemAccessor[]	r	リスト項目
Name	string	rw	現在のプレイリストの名前
Path	string	rw	現在のプレイリストのパス
SelectedItems	PlaylistItemAccessor[]	rw	選択されているリスト項目
Style	string (PanelListItemStyle)	rw	リスト項目表示形式

メソッド

Close()	void	パネルを閉じる
Open()	void	パネルを開く
OpenDock()	void	ドッキング状態でパネルを開く
OpenFloat()	void	フローティング状態でパネルを開く

[Class] QuickAccessFolderNodeAccessor

クイックアクセスフォルダーのアクセサ

このクラスは NodeAccessor を継承しています。

プロパティ

Children	NodeAccessor[]	r	子ノード
Index	int	r	インデックス番号
IsDisposed	bool	r	破棄されたノードならば "true"
IsExpanded	bool	rw	ノードが展開状態であれば "true"
Name	string	r	ノードの名前
Parent	NodeAccessor	r	親ノード
Value	QuickAccessFolderNodeSource	r	クイックアクセスフォルダーのプロパティ
ValueType	string	r	ノードの値の型

メソッド

Add(dictionary)

新しいクイックアクセスを作成して追加する

パラメーター

parameter

dictionary

新しいクイックアクセスのパラメーター (省略可)
パラメーター "Name"と "Path" を指定できます。

戻り値

新しいクイックアクセス

例

// Create quick access by specifying only path
nv.Bookshelf.FolderTree.QuickAccessNode.Add({Path:"C:\\FooBar"})

Insert(int, dictionary)

新しいクイックアクセスを作成して挿入する

パラメーター

index	int	挿入位置
parameter	dictionary	新しいクイックアクセスのパラメーター (省略可) パラメーター "Name"と "Path" を指定できます。

戻り値

新しいクイックアクセス

例

// Create quick access with name and path
nv.Bookshelf.FolderTree.QuickAccessNode.Insert(0, {Name:"AAA", Path:"C:\\FooBar"})

[Class] QuickAccessFolderNodeSource

クイックアクセスフォルダーのプロパティ

プロパティ

Name

string

名前

[Class] QuickAccessNodeAccessor

クイックアクセスノードのアクセサ

このクラスは NodeAccessor を継承しています。

プロパティ

Index	int	r	インデックス番号
IsDisposed	bool	r	破棄されたノードならば "true"
Name	string	r	ノードの名前
Parent	NodeAccessor	r	親ノード
Value	QuickAccessNodeSource	r	クイックアクセスのプロパティ
ValueType	string	r	ノードの値の型

メソッド

MoveTo(int)

void

インデックス位置を変更する

パラメーター

newIndex

int

新しいインデックス番号

Remove()

bool

自身を削除する

戻り値

bool	削除に成功したら "true"

[Class] QuickAccessNodeSource

クイックアクセスのプロパティ

プロパティ

Name	string	rw	名前
Path	string	rw	クイックアクセスのパス

[Class] SusiePluginAccessor

Susie プラグインのアクセサ

プロパティ

ApiVersion	string	r	API バージョン
DetailText	string	r	詳細テキスト
Extensions	string	rw	拡張子。セミコロンで複数指定可能。nullで初期化
HasConfigDialog	bool	r	設定ダイアログが存在する
IsCacheEnabled	bool	rw	プラグインをキャッシュする
IsEnabled	bool	rw	プラグイン有効
IsPreExtract	bool	rw	書庫を事前展開する
Name	string	r	名前
Path	string	r	パス
PluginType	string (SusiePluginType)	r	Susie プラグインの種類
PluginVersion	string	r	プラグインバージョン

メソッド

ShowConfigDialog()

void

設定ダイアログを開く

[Class] SusiePluginCollectionAccessor

Susie プラグインコレクションのアクセサ

プロパティ

AMPlugins	SusiePluginAccessor[]	r	書庫プラグイン
INPlugins	SusiePluginAccessor[]	r	画像プラグイン

[Class] TrackCollectionAccessor

メディアプレイヤートラックのアクセサ

プロパティ

SelectedIndex	int	rw	選択されているトラック番号
Tracks	string[]	r	トラックリスト

[Class] ViewPageAccessor

ビューページアクセサ。表示しているページ情報にアクセスします。

このクラスは PageAccessor を継承しています。

プロパティ

CreationTime	Date	r	作成日時
Height	double	r	ページの高さ
Index	int	r	ページインデックス。数字は 0 から始まる。
IsBook	bool	r	ブックとして開くことができる
LastWriteTime	Date	r	更新日時
Path	string	r	ページのパス
Player	MediaPlayerAccessor	r	メディアプレイヤー。メディアでない場合は null
RawPath	string	r	未加工のパス
Size	int	r	ファイルサイズ (Byte)
Width	double	r	ページの幅

メソッド

GetMetaValue(string)

string

ページのメタ情報を得る

パラメーター

key

string

メタ情報の項目名。詳細は検索オプションのヘルプを参照してください。

戻り値

string

メタ情報の値

GetMetaValueMap()

dictionary

ページのメタ情報一覧を得る

戻り値

dictionary

ページのメタ情報の連想配列

GetPageAccessor()

このページの PageAccessor を得る

戻り値