プロパティーとメソッド (API)
Apache OpenOffice Basic の各オブジェクトからは、各種のプロパティーとメソッドを呼び出すことができます。
プロパティー
「プロパティー」とはオブジェクトのもつプロパティーと同様のもので、たとえば Document オブジェクトには Filename や Title などのプロパティーが存在します。
プロパティーは、値を代入することにより設定されます。
Document.Title = "{{OOo}} Basic Programmer's Guide"
Document.Filename = "basguide.odt"
各プロパティーには、通常の変数と同様に、どのような値を格納できるかを規定するタイプ (型) が存在します。前のプロパティー Filename および Title は、文字列タイプの一種です。
リアル属性とイミテーション属性
Apache OpenOffice Basic の各オブジェクトのもつプロパティーの大部分は、UNO サービスとして定義されています。Apache OpenOffice Basic のプロパティーには、このような「リアル」なプロパティー以外に、UNO レベルの 2 つのメソッドから成るプロパティーが存在します。その一方は、そのプロパティー値を取得する際に、もう一方は値を指定する際に使用します (get メソッドと set メソッド)。つまり、このような属性は、これら 2 つのメソッドの「イミテーション」として存在するとも言えます。たとえば UNO の文字オブジェクトには、該当するキーポイントの取得と変更を行う getPosition および setPosition というメソッドが用意されています。Apache OpenOffice Basic のプログラムでこのような値にアクセスするには、Position プロパティーを使用します。そしてこれらとは独立した形で、オリジナルのメソッドも使用できます (ここでの例の場合は getPosition および setPosition)。
メソッド
メソッドとは、特定のオブジェクトを指定して実行する、一種の関数と見なすことができます。たとえば、先に説明した Document オブジェクトには、Save というメソッドが存在し、これは次のような形式で使用します。
Document.Save()
このようなメソッドを使用する際には、関数を呼び出す場合と同様に、パラメータの指定および戻り値の取得が行えます。実際そのようなメソッドの呼び出しは、通常の関数と同様の形式で行えます。次の呼び出しでは、ドキュメントオブジェクトの Save メソッドを呼び出す際に、パラメータとして True を指定しています。
Ok = Document.Save(True)
この Save メソッドによる処理が終了すると、その戻り値が変数 Ok に格納されます。
| Content on this page is licensed under the Public Documentation License (PDL). |
