Application オブジェクト

汎用プロパティ

ActiveDocument (Object、読み取り専用)

アクティブドキュメント。詳細については、「ActiveDocument オブジェクト」を参照してください。

ApplicationType (Integer、読み取り専用)

現在のアプリケーションタイプ

0 - HomeSite
1 - ColdFusion Studio
2 - JRun Studio

次のスクリプトコードはアプリケーションタイプのテストに使うことができます。

/*    アプリケーションをテストします。ApplicationType プロパティは次のとおりです。
    0 = HomeSite
    1 = CF Studio
    2 = JRun Studio
*/
function Main(){
    var iAppType;
    var sMessage;
    
    with (Application) {
        if (IsColdFusionStudio)
            MessageBox('IsColdFusionStudio は True を返します。', 'Application 
Type', 0)
        else
            MessageBox('IsColdFusionStudio は False を返します。', 'Application 
Type', 0);
    
    iAppType = ApplicationType;

        switch(iAppType) {
            case 0: {
                sMessage = 'HomeSite';
            }
            case 1: {
                sMessage = 'ColdFusion Studio';
            }
            case 2: {
                sMessage = 'JRun Studio';
            }
            default: {
                sMessage = '不明なアプリケーション タイプ';
            }
        }
        
        MessageBox('使用中のアプリケーション' + sMessage + '.', 'Application 
Type', 0);                        
    }
}

AppPath (OleString、読み取り専用)

実行可能なアプリケーションへのパス。

CurrentFolder (OleString)

ローカルファイルリストに現在表示されているパス。

CurrentView (ITCurrentViewType)

現在のビューを設定するか、または取得します。

次の値から選択します。

1 - vwEditSource
2 - vwPreview (browse)
3 - vwDesign

DocumentCache (Object の配列、読み取り専用)

詳細については、「DocumentCache オブジェクト」を参照してください。

DocumentIndex (Integer)

現在のドキュメントのタブインデックス。

DocumentCount (Integer、読み取り専用)

開いているドキュメントの数。

ExeName (OleString、読み取り専用)

実行可能なアプリケーションのファイル名 (パスを含む)。

Height (Integer)

メインウィンドウの高さ (ピクセル単位)。

HInstance (Integer、読み取り専用)

アプリケーションのインスタンスハンドル。

hWnd (Integer、読み取り専用)

メインウィンドウへのハンドル。

IsColdFusionStudio (WordBool、読み取り専用)

アプリケーションが ColdFusion Studio または JRun Studio の場合は True を返し、HomeSite の場合は False を返します。

Left (Integer)

メインウィンドウの左端 (x 座標)。

ResourceTabShowing (WordBool)

リソースタブを表示するかどうかを指定します。

ResultsShowing (WordBool)

結果タブを表示するかどうかを指定します。

Top (Integer)

メインウィンドウの上部 (Y 軸座標)。

VersionText (OleString、読み取り専用)

アプリケーション名とバージョン。

Width (Integer)

アプリケーションのメインウィンドウの幅 (ピクセル単位)。Height プロパティとともに使うと、ウィンドウのサイズを変更するだけでなく、メインウィンドウのサイズを調べることができます。

WindowState (Integer)

次の値から選択します。

0- Normal
1- Minimized
2- Maximized

汎用メソッド

BringToFront

procedure BringToFront()

他のアプリケーションの手前にメインウィンドウを表示します。

BrowseText

procedure BrowseText(sText, BaseHREF: OleVariant)

渡されたテキストを内部ブラウザで表示します。BaseHREF パラメータは、相対パスの解釈に使います。ローカルファイルの場合、BaseHREF は、ローカルファイルが保存されているフォルダにしてください。

CloseAll

function CloseAll(wbPromptToSave: WordBool): WordBool

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

ExecCommand

procedure ExecCommand(nCmdID: Integer, nOptions: Integer)

CommandID に基づいて、特定のコマンドを実行します。使用可能なコマンドについては、「CommandID 値の表」を参照してください。nOptions をカーソル移動コマンドで使うと、カーソルの移動中にテキストが選択されたか (nOptions = 1)、または選択されなかったか (nOptions = 0) を判断することができます。その他のコマンドでは、nOptions は 0 として渡されます。

ExtractFileName

function ExtractFileName(const wsFile: WideString): WideString

渡されたファイル名から拡張子を除いた部分のみを返します。

ExtractFilePath

function ExtractFilePath(const wsFile: WideString): WideString

渡されたファイルのパスを返します (後続の '\' を含む)。

GetApplicationSetting

function GetApplicationSetting(nSettingID: Integer)

SettingID に基づいて特定のアプリケーション設定を取り出します。

GetImageSize

function GetImageSize(const wsImageFile: WideString; var nHeight, nWidth: Integer): WordBool

渡されたイメージのサイズを検索します。エラーが発生すると False を返します。

GetMemoryStatus

function GetMemoryStatus(iMemType)

整数値を返します。値は次のとおりです。

0 - 使用可能なシステムリソース (%)

1 - 使用可能な GDI リソース (%)

2 - 使用可能なユーザリソース (%)

3 - 使用中の汎用メモリ (%)

4 - 物理メモリの合計 (バイト)

5 - 使用可能な物理メモリ (バイト)

6 - スワップファイルの記憶領域の合計 (バイト)

7 - 使用可能なスワップファイルの記憶領域 (バイト)

8 - 仮想領域の合計 (バイト)

9 - 使用可能な仮想領域 (バイト)

Win 95/98 では、値 0、1、および 2 に対する値は実際の値です。NT では、リソースレベルの取得に対応する API 呼び出しがないので、それらについては、常に 80% の値を返します。

GetRelativePath

function GetRelativePath(const wsBaseURL, wsFolderURL: WideString): WideString

基本 URL を示すフォルダの相対パスを返します。たとえば、

GetRelativePath ("http://www.allaire.com/", "http://www.allaire.com/
products/")

は、"products/" を返します。

GetTabIndexForFile

function GetTabIndexForFile(const wsFile: WideString): Integer

渡されたファイルのドキュメントタブ内のインデックスを返します。ファイルが開いていない場合は -1 を返します。

GetURL

function GetURL(const wsURL: WideString): widestring

URL を検索し、そのコンテンツを返します。

GetURLStatus

function GetURLStatus(const wsURL: WideString; var vResponse: OleVariant): Integer

渡された URL の HTTP ステータスコードを返します。サーバ応答のテキストは、2 番目のパラメータを使って返されます。

HideProgress

procedure HideProgress()

進行状況表示バーを隠します。

HTMLConvertTagCase

function HTMLConvertTagCase(const wsHTML: WideString; const wbUpperCase: WordBool): WideString

渡された HTML 文字列の大文字と小文字を変換します。ただし、SCRIPT、STYLE、または COMMENT タグの内容は変更されず、属性値の大文字と小文字も変更されません。

HTMLGetAttribute

function HTMLGetAttribute(const wsInTag, wsAttr: WideString): WideString

タグの特定の属性の値を返します。たとえば、

HTMLGetAttribute("&lt;TABLE WIDTH=100&gt;", "WIDTH");

は、100 を返します。

HTMLGetTitle

function HTMLGetTitle(const wsFile: WideString): WideString

HTML ファイルの <TITLE> タグの内容を返します。この関数はローカルファイルに対してのみ動作するので注意してください。

InputBox

function InputBox(const wsCaption, wsPrompt, wsDefault: WideString): WideString

ユーザ入力を取得するためにダイアログボックスを表示します。

IsFileOpen

function IsFileOpen(sFile: OleVariant): WordBool

渡されたファイルがドキュメントタブ内で開いている場合は True を返します。

IsFileModified

function IsFileModified(sFile: OleVariant): WordBool

渡されたファイルが、ドキュメントタブ内で開いており、変更されている場合は True を返します。

InstallParserScript

function InstallParserScript(const wsScriptFile, wsFileExtAssoc: WideString): WordBool

パーサ (色分け) スクリプトをインストールし、このパーサを、渡されたファイル拡張子リスト (セミコロンで区切る) に関連付けます。既存のパーサがこれらのいずれかのファイル拡張子に割り当てられている場合、その拡張子は既存のパーサから取り除かれ、新しいパーサに割り当てられます。パーサスクリプトは、渡された場所からアプリケーションの \Parsers サブディレクトリにコピーされます。エラーが発生した場合は False を返します。

LogMemoryStatus

function LogMemoryStatus(const wsLogFile, wsDescrip: WideString)

現在のメモリステータスをログファイルに書き込みます。

wsLogFile: logfilename - ファイルがない場合は作成し、ファイルがある場合はそのファイルにステータスを追加します。

wsDescrip: text - エントリを説明するテキスト

MessageBox

MessageBox(const wsText, wsCaption: WideString, nType: Integer): Integer

ユーザ応答を取得するために、メッセージダイアログボックスを表示します。nType パラメータは、表示されるダイアログボックスのタイプを指定します。このパラメータには、次の値を組み合わせて指定してください。

MB_ICONINFORMATION = 64
MB_ICONWARNING = 48
MB_ICONQUESTION    = 32
MB_ICONSTOP    = 16
MB_ABORTRETRYIGNORE    = 2
MB_OK = 0 (既定)
MB_OKCANCEL = 1
MB_RETRYCANCEL = 5
MB_YESNO = 4
MB_YESNOCANCEL = 3

この関数の結果は、押されたボタンの ID を格納します。押されるボタンは、次のいずれかです。

IDOK = 1
IDCANCEL = 2
IDABORT = 3
IDRETRY = 4
IDIGNORE = 5
IDYES = 6
IDNO = 7
IDCLOSE = 8

NewDocument

procedure NewDocument(wbUseDefaultTemplate: WordBool)

既定のテンプレートから新規ドキュメントを作成します。

OpenFile

function OpenFile(const wsFile: WideString): WordBool

渡されたファイルを開き、成功した場合は True を返します。すでにファイルが開いている場合も True を返すので注意してください。OpenFile に空の文字列を渡すと、ユーザが開くファイルを選択できる、[ファイルを開く] ダイアログボックスを開きます。

NextDoc

procedure NextDoc()

ドキュメントタブ内の次のドキュメントに移動します。最後のドキュメントが表示されている場合は、最初のドキュメントにラップします。

PreviousDoc

procedure PreviousDoc()

ドキュメントタブの前のドキュメントに移動します。最初のドキュメントが表示されている場合は、最後のドキュメントにラップします。

Quit

procedure Quit()

プログラムを終了します。終了前に未保存のドキュメントを保存するようにユーザに求めるプロンプトを表示します。

RunCodeSweeper

procedure RunCodeSweeper()

アクティブ CodeSweeper を使って、アクティブドキュメントに対して CodeSweeper を実行します。アクティブ CodeSweeper を変更するには、SetActiveCodeSweeper を使用します。

SaveAll

function SaveAll(): WordBool

開いているすべてのドキュメントを保存します。保存に成功した場合は True を返します。

SendToBack

procedure SendToBack()

他のアプリケーションの背後にメインウィンドウを表示します。

SetActiveCodeSweeper

function SetActiveCodeSweeper(const wsFileName: WideString): WordBool

アクティブ CodeSweeper のフォーマットファイルを変更します。

SetActiveResults

procedure SetActiveResults(resType: TCurrentResultsType)

結果タブ内のアクティブページを設定します。

次の値から選択します。

resSearch
resValidator
resLinks
resThumbnails

SetApplicationSetting

procedure SetApplicationSetting(nSettingID: Integer ovSettingVal: OleVariant)

SettingID に基づいた特定のアプリケーション設定を設定します。

SetProgress

procedure SetProgress(nProgress: Integer)

ステータス領域内の進行状況表示バーの位置を設定します。許されている値は 1 ～ 100 です。

SetStatusText

procedure SetStatusText(sMessage: OleString)

ステータス領域に表示されるテキストを設定します。

ShellToApp

function ShellToApp(const wsAppFileName: WideString): WordBool

外部アプリケーションを実行します。アプリケーションの起動に成功した場合は True を返します。ファイル名パラメータにコマンドラインを含めることができます。したがって、コードを次のように記述することができます。

Application.ShellToApp("notepad.exe " + 
Application.ActiveDocument.Filename)

ShellToAppAndWait

procedure ShellToAppAndWait(const wsAppFileName: WideString)

このメソッドは、ShellToApp と機能は同じですが、外部プログラムが閉じるのを待ってから値を返す点が異なります。アプリケーションは、ShellToAppAndWait が値を返すまでロックされます。注意して使ってください。

ShowProgress

procedure ShowProgress()

進行状況表示バーを表示します。

ShowThumbnails

procedure ShowThumbnails(sFolder: OleString)

渡されたフォルダ内のすべてのイメージのサムネールを表示します。

StatusError

procedure StatusError(const wsMsg: WideString)

ステータスバー内にエラーメッセージを表示します。メッセージは、赤い背景に最低 5 秒間表示されます。

StatusWarning

procedure StatusWarning(const wsMsg: WideString)

ステータスバーに警告メッセージを表示します。メッセージは、青い背景に最低 5 秒間表示されます。

TagCase

function TagCase(const wsTag: WideString): WideString

[オプション] > [設定] ダイアログボックスの HTML パネル内の、[すべてのタグを小文字で挿入する] という設定を基に、渡された文字列の大文字と小文字を変換します。属性値の大文字と小文字は変換されません。

Wait

procedure Wait(nMilliseconds: Integer)

所定の時間 (ミリ秒単位) 一時停止します。スクリプトがループ実行中も UI を利用できるようにするには、Wait を使います。次の JavaScript サンプルは、ユーザがソースビューの編集に戻るまで待機するコードです。

var app = Application;
while (app.CurrentView != 1) {
    app.Wait(100);            
}

次は、VBScript で記述した同じコードです。

set app = Application
while app.CurrentView  1
    app.Wait (100)
wend

ループ内で Wait への呼び出しを行わないと、アプリケーションはロックされて表示されるので、ユーザはビューを変更できなくなります。

プロジェクトプロパティ

ActiveProjectFile (読み取り専用文字列)

アクティブプロジェクトのファイル名を返します。あるいは、プロジェクトが開いていない場合は空の文字列を返します。

プロジェクトメソッド

AddFileToProject

function AddFileToProject(const wsFilename: WideString): WordBool

渡されたファイルをアクティブプロジェクトに追加します。そのファイルは、メインプロジェクトフォルダ、またはメインプロジェクトのサブフォルダに格納されます。

CloseProject

function CloseProject(wbCloseOpenFiles: WordBool): WordBool

アクティブプロジェクトを閉じます。wbCloseOpenFiles が True の場合は、開いているすべてのファイルが閉じます。

OpenProject

function OpenProject(const wsProjectFile: WideString): WordBool

渡されたプロジェクトファイルを開いて、これをアクティブプロジェクトにします。[プロジェクトを開く] ダイアログボックスを表示するには、空の文字列を渡してください。

RemoveFileFromProject

function RemoveFileFromProject(const wsFilename: WideString): WordBool

渡されたファイルをアクティブオブジェクトから削除します。

ShowLastProjectError

function ShowLastProjectError()

最新のプロジェクト関連エラーについてエラーメッセージを表示します。

UploadProjectDlg

function UploadProjectDlg(): WordBool

アクティブプロジェクトの [プロジェクトをアップロード] ダイアログボックスを表示します。

UploadProject

function UploadProject(const wsTargetDir: WideString; const wbForceLCase, wbUploadOnlyNewer, wbEncryptCFML: WordBool): WordBool

渡された条件を基に、プロジェクトをアップロードします。wbEncryptCFML は、ColdFusion Studio 専用です。

ツールバーメソッド

各ツールバーは固有の名前で識別されます。名前は、ツールバーがドッキングされていないときに表示されるタイトルバーキャプションと同じです。2 つのツールバーに同じ名前およびキャプションは付きません。ツールバーは、ツールバーディレクトリに保存されているファイルから読み込まれます。このツールバーディレクトリは、ToolbarDir プロパティから取得することができます。ツールバー名は、パスや拡張子を抜いたツールバーファイル名と同じです。たとえば、ツールバーファイルが \toolbars\Custom.tbr の場合、ツールバー名は "Custom" です。さらに、ツールボタンのキャプションは 2 文字に制限されるので注意してください。

AddAppToolbutton

function AddAppToolbutton(wsToolbarName, wsExeFile, wsCmdLine, wsHint: WideString): WordBool

外部アプリケーションのためのツールボタンを、渡されたツールバーに追加します。ツールバーが存在しないか、ツールボタンを追加できない場合は、エラーになります。同じツールボタン (wsExeFile および wsCmdLine に基づく) が、すでにツールバーに存在する場合は True を返しますが、ボタンが重複して追加されることはありません。

AddScriptToolbutton

function AddScriptToolbutton(wsToolbarName, wsScriptFile, wsHint, wsCaption, wsImageFile: WideString): WordBool

渡されたツールバーにスクリプトツールボタンを追加します (クリックされると、渡された JavaScript または VBScript ファイルを実行します)。ツールバーが存在しない場合はエラーになります。ツールボタンがすでに存在する場合は True を返しますが、ボタンが重複して追加されることはありません。

AddTagToolbutton

function AddTagToolbutton(wsToolbarName, wsTagStart, wsTagEnd, wsHint, wsCaption, wsImageFile: WideString): WordBool

渡されたツールバーにタグツールボタンを追加します (クリックされると、タグペアを挿入します)。ツールバーが存在しない場合はエラーになります。ツールボタンがすでに存在する場合は True を返しますが、ボタンが重複して追加されることはありません。

AddVTMToolbutton

function AddVTMToolbutton(wsToolbarName, wsScriptFile, wsHint, wsCaption, wsImageFile: WideString): WordBool

渡されたツールバーにVTM ツールボタンを追加します (クリックされると、渡された VTM ダイアログボックスを表示します)。ツールバーが存在しない場合はエラーになります。ツールボタンがすでに存在する場合は True を返しますが、ボタンが重複して追加されることはありません。

CreateToolbar

function CreateToolbar(wsToolbarName: WideString): WordBool

渡された名前を使って、ドッキングしていないツールバーを新規に生成します。同じ名前のツールバーがすでに存在する場合はエラーになります。

DeleteToolbar

function DeleteToolbar(wsToolbarName: WideString): WordBool

ツールバーを物理的に削除します。ツールバーが存在しないか、ツールバーが既定のツールバーである場合は、エラーになります。この関数は、独自のツールバーに対してのみ動作します。既定のツールバーは隠せますが、削除することはできません。

HideToolbar

function HideToolbar(wsToolbarName: WideString): WordBool

ツールバーを隠します。ツールバーが存在しない場合はエラーになります。

SetToolbarDockPos

function SetToolbarDockPos(wsToolbarName: WideString; nDockPos: Integer): WordBool

ツールバーのドッキング位置を設定します。nDockPos の許されている値は次のとおりです。

1 = Top
2 = Bottom
3 = Left
4 = Right

ツールバーが存在しない場合はエラーになります。

ShowToolbar

function ShowToolbar(wsToolbarName: WideString): WordBool

ツールバーがまだ表示されていない場合は、ツールバーを表示します。ツールバーが存在しない場合はエラーになります。

次の JavaScript によるコード例は、ツールバーが存在しない場合に "Apps" という名前のツールバーを生成し、これに 2 つの独自のツールボタンを追加します。最初のツールボタンは Windows エクスプローラを起動し、2 番目のツールボタンは、現在のフォルダにおいてエディタを使って Windows エクスプローラを開きます。

function Main() {        
    var TB_NAME = `Apps';
    var app = Application;    

    if (!app.ToolbarExists(TB_NAME)) {
        app.CreateToolbar(TB_NAME);
    }
    app.AddAppToolbutton(TB_NAME, `c:\\windows\\explorer.exe', ",
    `Explorer');
    app.AddAppToolbutton(TB_NAME, `c:\\windows\\explorer.exe', 
        app.CurrentFolder, 'Explorer - Current Folder');    
}

次は、VBScript で記述した同じコードです。

Sub Main
    const TB_NAME = "Apps"
    Dim app

    set app = Application
    if not app.ToolbarExists(TB_NAME) then
        app.CreateToolbar TB_NAME
    end if

    app.AddAppToolbutton TB_NAME, "c:\windows\explorer.exe", "",
        "Explorer"
    app.AddAppToolbutton TB_NAME, "c:\windows\explorer.exe",
        app.CurrentFolder, "Explorer - Current Folder"
End Sub

ToolbarDir

function ToolbarDir (widestring、読み取り専用プロパティ)

ツールバーファイルが配置されているパスを返します。

ToolbarExists

function ToolbarExists(wsToolbarName: WideString): WordBool;

渡されたツールバーが存在する場合は True を返します。

Visual Tools Object Model の作成
Visual Tools Object Model の作成

Application オブジェクト

汎用プロパティ

ActiveDocument (Object、読み取り専用)

ApplicationType (Integer、読み取り専用)

AppPath (OleString、読み取り専用)

CurrentFolder (OleString)

CurrentView (ITCurrentViewType)

DocumentCache (Object の配列、読み取り専用)

DocumentIndex (Integer)

DocumentCount (Integer、読み取り専用)

ExeName (OleString、読み取り専用)

Height (Integer)

HInstance (Integer、読み取り専用)

hWnd (Integer、読み取り専用)

IsColdFusionStudio (WordBool、読み取り専用)

Left (Integer)

ResourceTabShowing (WordBool)

ResultsShowing (WordBool)

Top (Integer)

VersionText (OleString、読み取り専用)

Width (Integer)

WindowState (Integer)

汎用メソッド

BringToFront

BrowseText

CloseAll

ExecCommand

ExtractFileName

ExtractFilePath

GetApplicationSetting

GetImageSize

GetMemoryStatus

GetRelativePath

GetTabIndexForFile

GetURL

GetURLStatus

HideProgress

HTMLConvertTagCase

HTMLGetAttribute

HTMLGetTitle

InputBox

IsFileOpen

IsFileModified

InstallParserScript

LogMemoryStatus

MessageBox

NewDocument

OpenFile

NextDoc

PreviousDoc

Quit

RunCodeSweeper

SaveAll

SendToBack

SetActiveCodeSweeper

SetActiveResults

SetApplicationSetting

SetProgress

SetStatusText

ShellToApp

ShellToAppAndWait

ShowProgress

ShowThumbnails

StatusError

StatusWarning

TagCase

Wait

プロジェクト プロパティ

ActiveProjectFile (読み取り専用文字列)

プロジェクト メソッド

AddFileToProject

CloseProject

OpenProject

RemoveFileFromProject

ShowLastProjectError

UploadProjectDlg

UploadProject

ツールバー メソッド

AddAppToolbutton

AddScriptToolbutton

プロジェクトプロパティ

プロジェクトメソッド

ツールバーメソッド