Visual Tools Object Model の作成 戻る 1 つ上のページに戻る 次へ
Visual Tools Object Model の作成



ActiveDocument オブジェクト

ActiveDocument オブジェクトは、エディタで現在表示されているドキュメントを参照するときに使います。開いているがアクティブでないドキュメントにアクセスするには、Application.DocumentCache オブジェクトを使います。

プロパティ

CanRedo (WordBool、読み取り専用)

変更を再試行できる場合は True を返します。

CanUndo (WordBool、読み取り専用)

変更を取り消すことができる場合は True を返します。

Filename (OleString、読み取り専用)

アクティブ ドキュメントのファイル名を返します。

Lines(Index: Integer) (OleString)

渡されたインデックスを使って、行のテキストの取得や設定を行います。Lines プロパティを使って、大きなドキュメントを繰り返し処理すると、処理速度は遅くなります。したがって、テキストを 1 行ずつ評価するときのみ、Lines プロパティを使うことをお勧めします。Lines プロパティを使って多数の行を更新する必要がある場合は、BeginUpdate..EndUpdate ブロック内で更新をラップすることにより、性能を向上させることができます。

LineCount (Integer、読み取り専用)

アクティブ ドキュメント内の行数を返します。

Modified (WordBool、読み取り専用)

ドキュメントが最後の保存以降に変更されている場合は True を返します。

ReadOnly (WordBool、読み取り専用)

アクティブ ドキュメントが読み取り専用の場合は True を返します。

SelStart (Integer)

現在選択されている部分の先頭を取得するか、または設定します。

SelLength (Integer)

現在の選択肢の長さを取得するか、または設定します。

SelText (OleString)

現在選択されている部分のテキストを取得するか、または設定します。

TabIndex

ドキュメント タブのタブ インデックスを取得するか、または設定します。

Text (OleString)

完全なドキュメント テキストを取得するか、または設定します。

メソッド

BeginUpdate

procedure BeginUpdate()

アクティブ ドキュメントの画面更新機能をオフにします。このメソッドは、スクリプトが、アクティブ ドキュメントに対して 1 度に複数の変更を加えるときに役立ちます。このプロシージャ実行時に画面更新機能をオフにすると、速度が大幅に向上します。画面更新機能をオンに戻すには、EndUpdate を使ってください。

BeginUpdate...EndUpdate は注意して使ってください。BeginUpdate の呼び出し後に EndUpdate を呼び出さなかったり、BeginUpdateEndUpdate が呼び出される前にスクリプトがクラッシュしたりすると、EndUpdate ユーザは、加えられた変更をエディタで表示することができなくなります。

Clear

procedure Clear()

アクティブなドキュメントからすべてのテキストをクリアします。

Close

function Close(wbPromptToSave: WordBool): WordBool

アクティブ ドキュメントを閉じます。wbPromptToSave が True の場合は、変更を保存するように求めるプロンプトが表示されます。ドキュメントを閉じた場合 (すなわち、ユーザが変更を保存した場合) は True を返します。

EndUpdate

procedure EndUpdate()

アクティブ ドキュメントの画面更新機能をオンにします。

GetCaretPos

procedure GetCaretPos(var x, y: Integer)

キャレットの位置を返します (x=列, y=行)。

GetCurrentChar

function getCurrentChar(): OleVariant

現在の文字を返します。

GetNextChar

function GetNextChar(): OleVariant

次の文字を返します。長いループ内でこの関数を GetPreviousChar とともに使うと、処理速度が低下します。

GetPreviousChar

function GetPreviousChar(): OleVariant

前の文字を返します。

GetTagAtCursor

function GetTagAtCursor(wbSelect: WordBool): WideString;

エディタ内の現在カーソルが置かれているタグを返します。タグが識別できない場合、メソッドは空の文字列を返します。

wbSelect が True の場合、タグはドキュメント内で選択 (強調表示) されます。

例 : 

// 現在のタグを持つメッセージ ボックスを表示します。
function Main() {

with (Application) {

MessageBox(ActiveDocument.GetTagAtCursor(false), 'カーソル位置にある現在のタグ', 0);

}

}

GotoNextEndTag

function GotoNextEndTag(wbSelect: WordBool): WordBool

wbSelect が True の場合は、次の終了タグに移動してこのタグを選択します。タグが検出されない場合は False を返します。

GotoNextStartTag

function GotoNextStartTag(wbSelect: WordBool): WordBool

wbSelect が True の場合は、次の終了タグに移動してこのタグを選択します。タグが検出されない場合は False を返します。

GotoPreviousEndTag

function GotoPreviousEndTag(wbSelect: WordBool): WordBool

wbSelect が True の場合は、次の終了タグに移動してこのタグを選択します。タグが検出されない場合は False を返します。

GotoPreviousStartTag

function GotoPreviousStartTag(wbSelect: WordBool): WordBool

wbSelect が True の場合は、次の終了タグに移動してこのタグを選択します。タグが検出されない場合は False を返します。

Indent

procedure Indent()

現在選択されている部分をインデントします。

InsertTag

procedure InsertTag(sStartTag, sEndTag: OleVariant; wbOverwriteSelection: WordBool)

wbOverwriteSelection が True の場合は、渡されたタグのペアを現在のカーソル位置に挿入し、現在選択されている部分を置き換えます。この操作後、カーソルは開始タグと終了タグの間に配置されます。また、wbOverwriteSelection が False の場合、現在選択されている部分はタグで囲まれます。

InsertText

procedure InsertText(InsertStr: OleVariant; wbOverwriteSelection: WordBool)

wbOverwriteSelection が True の場合は、渡された文字列を現在のカーソル位置に挿入し、現在選択されている部分を置き換えます。

LastSavedDate

function LastSavedDate()

アクティブ ドキュメント ファイルを最後に保存した日付時刻値を返します。

Print

procedure Print(wbNoPrompt: WordBool)

アクティブ ドキュメントを表示します。wbNoPrompt が True でなければ、表示設定値を求めるプロンプトが表示されます。

Redo

procedure Redo()

再試行操作を 1 回実行します。

Reload

procedure Reload(wbPromptToSave: WordBool)

wbPromptToSave が True の場合は、変更の保存を求めるプロンプトが表示されます。

ReplaceAll

function ReplaceAll(strSearch, strReplace: OleVariant; bMatchCase: WordBool): Integer

bMatchCase が True の場合は、strSearch のすべての発生を strReplace で置き換えます。 行われた置換の回数を返します。

Save

function Save: WordBool()

アクティブ ドキュメントに加えられた変更を保存し、成功した場合は True を返します。

SaveAs

function SaveAs(wsFileName: widestring): WordBool

アクティブ ドキュメントに加えられた変更を、wsFileName パラメータで指定されているファイルに保存し、成功した場合は True を返します。wsFileName が空の場合、通常の [別名で保存] ダイアログ ボックスが表示されます。この関数によって既存のファイルが上書きされるため、注意して使ってください。

SelectAll

procedure SelectAll()

アクティブ ドキュメント内のすべてのテキストを選択します。

SelectCurrentLine

procedure SelectCurrentLine()

現在の行を強調表示します。

SelectLine

procedure SelectLine(Index: Integer)

渡された行を強調表示します。

SetCaretPos

procedure SetCaretPos(x, y: Integer)

現在の列/行を設定します。

TextPosToEditorPos

function TextPosToEditorPos()

渡されたカーソル位置で、テキストに含まれているラインフィードの数を減算します。これによって、この値を他の VTOM 関数に渡して、カーソルを正しい位置に置くことができます。

Undo

procedure Undo()

取り消し操作を 1 回実行します。

Unindent

procedure Unindent()

現在選択されている部分のインデントを解除します。

カーソル移動プロシージャ

カーソルを配置するには、次のメソッドを使います。wbSelect が True の場合、現在の選択されている部分は新しいカーソル位置まで拡大されます。

procedure CursorDocEnd(wbSelect: WordBool)

procedure CursorDocStart(wbSelect: WordBool)

procedure CursorDown(wbSelect: WordBool)

procedure CursorLeft(wbSelect: WordBool)

procedure CursorLineEnd(wbSelect: WordBool)

procedure CursorLineStart(wbSelect: WordBool)

procedure CursorPageDown(wbSelect: WordBool)

procedure CursorPageUp(wbSelect: WordBool)

procedure CursorRight(wbSelect: WordBool)

procedure CursorUp(wbSelect: WordBool)

procedure CursorWordLeft(wbSelect: WordBool)

procedure CursorWordRight(wbSelect: WordBool)


Copyright © 2000, Allaire Corporation. All rights reserved. 戻る 1 つ上のページに戻る 次へ