jscrref

WHIP! リファレンス JavaScript/JScript

voidDrawView (double left, double right, double bottom, double top)

説明：
現在の視点をファイル座標（left、right、bottom、top）によって指定された視点に変更。
例：
document.whip.DrawView (100000, 200000, 100000, 200000)

void DrawNamedView (String name)

説明：
現在の視点を名前の付いた視点、name に関連付けられた視点に変更。
例：
document.whip.DrawNamedView ("KITCHEN")

boolSetCursorMode (long mode)
longGetCursorMode()

戻り値：
現在のカーソルモードの列挙型または void。

説明：
現在のカーソルモードを取得または設定。
次のモードがある。
1    画面移動
2    ズーム
4    選択範囲をズーム

注意：
カーソルモードを設定すると、UserInterface プロパティが上書きされ、ユーザは指定されたモードで対話する。
例：
document.whip.SetCursorMode (1)     // 画面移動モードに設定する

void SetUserInterface(boolean mode)
boolean GetUserInterface()

説明：
ユーザインタフェースのモードを設定または取得。True の場合、ユーザはマウスを使って図面と対話でき、図面を右クリックするとオプションメニューが表示される。
例：
var enabled = document.whip.GetUserInterface()
document.whip.SetUserInterface (false)

void SetHighlightURLs(boolean highlight_urls)
boolean GetHighlightURLs()

説明：
URL ハイライト表示のモードを設定または取得。True の場合、ファイルに埋め込まれたすべてのリンクがハイライト表示される。
例：
var enabled = document.whip.GetHighlightURLs()
document.whip.SetHighlightURLs (false)

int GetWindowExtentsLeft()
int GetWindowExtentsRight()
int GetWindowExtentsBottom()
int GetWindowExtentsTop()
戻り値：
現在のウィンドウの座標（ピクセル）。
例：
var left = document.whip.GetWindowExtentsLeft()

double GetDrawingExtentsLeft()
double GetDrawingExtentsRight()
double GetDrawingExtentsBottom()
double GetDrawingExtentsTop()
戻り値：
図面の最大範囲を指す四角形の座標（ファイル空間）。
例：
var left = document.whip.GetDrawingExtentsLeft()

double GetCurrentViewLeft()
double GetCurrentViewRight()
double GetCurrentViewBottom()
double GetCurrentViewTop()
戻り値：
現在の四角形視点の座標（ファイル空間）。

例：
var left = document.whip.GetCurrentViewLeft()

boolean BeginNamedViewSearch(String name)
説明：
BeginNamedViewSearch は次の 2 つの目的で使用します。
1. ファイルから特定の名前の付いた視点を見つける。
空の文字列ではない名前を指定することによって、ファイル内の特定の名前の付いた視点にアクセスできます。名前の付いた視点が存在する場合、BeginNamedViewSearch は True を返します。存在しない場合、False を返します。視点が存在する場合、GetNamedViewName、GetNamedViewLeft、その他の関数を呼び出すことによって、この名前の付いた視点に関連付けられたデータメンバーにアクセスできます。
2. 名前の付いた視点のリストの初めから検索を開始。
パラメータとして null 文字列を指定すると、リストの初めから検索を開始します。リストに名前の付いた視点が 1 つまたは複数ある場合、関数は True を返し、名前の付いた視点がファイルにない場合、False を返す。
例：
if (document.whip.BeginNamedViewSearch ("KITCHENVIEW"))
var left = document.whip.GetNamedViewName()
または
if (document.whip.BeginNamedViewSearch (""))
var name = document.whip.GetNamedViewName()

boolean FindNextNamedView()
戻り値：
「次の」名前の付いた視点がある場合は True、ない場合は False を返す。

説明：
リストにある次の名前の付いた視点を現在の視点にします。
例：
if (document.whip.BeginNamedViewSearch ("")) {
// 何かを行う
while (document.whip.FindNextNamedView())
}

String GetNamedViewName()
戻り値：
現在の名前の付いた視点の名前。
例：
if (document.whip.BeginNamedViewSearch ("")) var name = document.whip.GetNamedViewName()

double GetNamedViewLeft()
double GetNamedViewRight()
double GetNamedViewBottom()
double GetNamedViewTop()
戻り値：
現在の名前の付いた視点に関連付けられた四角形視点の座標（ファイル空間）。
例：
if (document.whip.BeginNamedViewSearch ("INITIAL"))
var left = document.whip.GetNamedViewLeft()

string GetFileVersion()
戻り値：
DWF ファイルのバージョンを示す文字列。
例：
var file = document.whip.GetFileVersion()

string GetUnits()
戻り値：
DWF ファイルの単位を示す文字列。

説明：
DWG を DWF として書き出す場合、オプションで USERS2 というテンポラリ変数に文字列を格納できます。この文字列は図面単位の名前を表します。この関数は DWF ファイル内の単位文字列を返します。
例：
var units = document.whip.GetUnits()

double[] ComputeCoordinate(long from_space, long to_space, double x, double y)
戻り値タイプ：
変換された座標が入った JavaArray

説明：
from_space 内の位置 (x,y) を to_space 内の新しい位置 (x',y') に変換。
次の任意の 2 つの空間の間の変換が可能です。
ソース (DWG) = 0
DWF = 1
ウィンドウ = 2
戻り値は配列で、1 番目のインデックスは x 座標、2 番目のインデックスは y 座標。
例：
function CC(){
    a = document.whip1.ComputeCoordinate(2,1,0,0)
    alert(a[0])
    alert(a[1])
}

boolean BeginLayerSearch(string name)

説明：
BeginLayerSearch は次の 2 つの目的で使用。
1. ファイル内の特定の画層を見つる。
空の文字列ではない画層名を指定することによって、ファイル内の特定の画層にアクセスできる。画層が存在する場合、 True を返し、存在しない場合、False を返す。画層が存在する場合、GetLayerName、その他の関数を呼び出すことによって、この画層に関連付けられたデータメンバーにアクセスできる。
2. 画層のリストの初めから検索を開始。
パラメータとして null 文字列を指定することによって、画層のリストの初めから検索を開始します。リストに画層が 1 つまたは複数ある場合、関数は True を返し、画層がファイルにない場合、False を返す。
例：
if (document.whip.BeginLayerSearch ("KITCHENVIEW"))
var visible = document.whip.GetLayerVisibility()
または
if (document.whip.BeginLayerSearch (""))
var name = document.whip.GetLayerName()

boolean FindNextLayer()
戻り値：
「次の」画層がある場合は True、ない場合は False を返します。

説明：
リストにある次の画層を現在の画層にします。
例：
if (document.whip.BeginLayerSearch (""))
{
    // 何かを行う
    while (document.whip.FindNextLayer())
    {
        // 何かを行う
    }
}

String GetLayerName()
戻り値： 現在の画層の名前。画層名は変更できません。
例：
if (document.whip.BeginLayerSearch (""))
var name = document.whip.GetLayerName()

booleanGetLayerVisibility()
void SetLayerVisibility()
戻り値：
取得：画層が可視の場合は True、そうでない場合は False。
設定：void

説明：
現在の画層の可視フラグを取得または設定。
例：
if (document.whip.BeginLayerSearch (""))
lyrnm = document.whip.SetLayerVisibility(True)

boolean BeginTextSearch(String name)

説明：
BeginTextSearch は次の 2 つの目的で使用します。
1. ファイルから特定のテキスト文字列を見つけます。空ではない文字列を指定することによって、ファイル内の特定のテキストオブジェクトにアクセスできます。ファイルに文字列が存在する場合、BeginTextSearch は True、存在しない場合、False を返す。文字列が存在する場合、GetTextName、その他の関数を呼び出すことによって、このテキストに関連付けられたデータメンバーにアクセスできます。
2. テキスト文字列のリストの初めから検索を開始します。 BeginTextSearch に対するパラメータとして null 文字列を指定することによって、テキスト文字列のリストの初めから検索を開始します。リストにテキスト文字列が 1 つまたは複数ある場合、関数は True を返し、テキスト文字列がファイルにない場合、False を返す。
注意：
テキスト文字列は、DWF TrueType テキスト文字列として指定しなければなりません。ジオメトリにはめ込まれた文字列は検索されません。
例：
if (document.whip.BeginTextSearch ("MARKET"))
var left = document.whip.GetTextLeft() // テキストを囲む境界ボックスの左座標を取得する。
または
if (document.whip.BeginTextSearch (""))
var text = document.whip.GetTextName()

boolean FindNextText()
戻り値：
現在のオブジェクトのあとにテキスト文字列がある場合は True、そうでない場合は False。

説明：
リストにある次のテキスト文字列を現在のテキスト文字列にします。
注意：
テキスト文字列は、DWF TrueType テキスト文字列として指定しなければなりません。ジオメトリにはめ込まれた文字列は検索されません。
例：
JavaScript
if (document.whip.BeginTextSearch (""))
{
    // 何かを行う
    while (document.whip.FindNextText())
    {
        // 何かを行う
    }
}

String GetTextString()
戻り値：
現在のテキストオブジェクトの文字列。

例： if (document.whip.BeginTextSearch (""))
var text = document.whip.GetTextString()

void GotoText()
戻り値：void

説明：
BeginTextSearch によって見つかった現在のテキストオブジェクトの境界ボックスを現在の視点にします。
注意：
テキスト文字列は、DWF TrueType テキスト文字列として指定しなければなりません。ジオメトリにはめ込まれた文字列は検索されません。
例：
// "main street" という文字列が見つかった位置を視点にします。
if (document.whip.BeginTextSearch ("main street"))
var text = document.whip.GotoText("main street")

double GetTextLeft()
double GetTextRight()
double GetTextBottom()
double GetTextTop()
戻り値：
現在のテキスト文字列を囲む四角形の境界ボックスの適切な座標（ファイル空間）。
例：
if (document.whip.BeginTextSearch (""))
var left = document.whip.GetTextLeft()

boolean BeginLinksSearch(String url)

説明：
BeginLinksSearch は次の 2 つの目的で使用します。
1. ファイルから特定のリンクを見つけます。空の文字列ではない url を指定することによって、ファイル内の特定のリンクにアクセスできます。ファイルにリンクが存在する場合、BeginLinksSearch は True を返し、存在しない場合、False を返す。リンクが存在する場合、スクリプトプログラマは、GetLinkURL、その他の関数を呼び出すことによって、このリンクに関連付けられたデータメンバーにアクセスできる。
2. リンクのリストの初めから検索を開始します。 BeginLinksSearch に対するパラメータとして null 文字列を指定することによって、リンクオブジェクトのリストの初めから検索を開始します。リストにリンクが 1 つまたは複数ある場合、 True を返し、リンクがファイルにない場合、False を返します。
注意：
完全な URL を指定しなければなりません。文字列の一部分を検索しようとした場合、FALSE が返されます。
例：
if (document.whip.BeginLinksSearch ("http://www.mycompany.com"))
var left = document.whip.GetLinkLeft() // リンクを囲む境界ボックスの左座標を取得する。
または
if (document.whip.BeginLinksSearch (""))
var url= document.whip.GetTextURL()

boolean FindNextLink()
戻り値：
リスト内の現在のリンクのあとにリンクがある場合は True、そうでない場合は False。

説明：
リストにある次のリンクを現在のリンクにします。
例：
if (document.whip.BeginLinksSearch (""))
{
    // 何かを行う
    while (document.whip.FindNextLink())
    {
        // 何かを行う
    }
}

String GetLinkURL()
戻り値：
現在のリンクオブジェクトの url。

例：
if (document.whip.BeginLinksSearch (""))
var url = document.whip.GetLinkURL()

double GetLinkLeft()
double GetLinkRight()
double GetLinkBottom()
double GetLinkTop()
戻り値：
現在のリンクを囲む四角形の境界ボックスの座標（ファイル空間）。
例：
if (document.whip.BeginLinksSearch (""))
var left = document.whip.GetLinkLeft()

void Clear ()
戻り値タイプ：void

説明：
ジオメトリとそれに関連するすべてのリストをファイルから除去。
例：
document.whip.Clear()

void Add (String buffer)
戻り値タイプ： void

説明：
WHIP! に ASCII DWF データを追加。
例：
// 図面にポリラインを追加する
document.whip.Add("(DWF V00.36)")
document.whip.Add("L 0,0 200000,200000")
document.whip.Add("(EndOfDWF)")
注意：
データの追加が終わったら、Add 関数の最後で更新を強制的に行うためにAdd("(EndOfDWF)")で終わる。
EndOfDWFで終わらないと自動的には更新されない。EndOfDWF は、DWF を更新するために必要に応じて複数回使用できます。

boolean PrintCurrentView ()
戻り値：
既定のシステムプリンタが存在する場合は TRUE、そうでない場合は FALSE を返します。

説明：
ファイルの現在の視点を既定のシステムプリンタに印刷。[印刷] ダイアログは呼び出されません。
例：
document.whip.PrintCurrentView()

boolean PrintSetup(boolean white_background, boolean black_geometery, boolean show_dialog, printer as variant)
戻り値：
[印刷] ダイアログでユーザが [キャンセル] をクリックしなかった場合は TRUE、[キャンセル] をクリックした場合は FALSE。

説明：
印刷に関する[背景を白にする]オプションと[ジオメトリを黒にする]オプションを設定します。また、ユーザが現在の視点の印刷を選択するための [印刷] ダイアログを呼び出します。Printer バリアントは必須ですが、結果には影響を与えません。
例：
If (PrintSetup(true, true, true, 1))
{
PrintCurrentView()
}
Else
{
Alert("User Canceled Print Dialog Box")
}