メソッドの一覧です。
共通のメソッド
COM専用のメソッド
ActiveX専用のメソッド
アセンブリ専用のメソッド
COMとActiveX、アセンブリ共通のメソッドです。
メソッド | 説明 |
---|---|
AddReport | 複数の帳票を開くための準備をします。 |
Close | 帳票を閉じます。 |
Create | 設定されている情報から出力イメージを作成します。 |
DataScript | データスクリプトを実行します。レコードの抽出や並べ替えが行えます。 |
ExportFile | データをフィルに出力します。 |
ExportStr | データを文字列で取得します。 |
GetBinaryImage | 帳票をメモリに保存し取得します。 |
GetDataCountX | データのフィールド(列)数を取得します。 |
GetDataCountY | データのレコード(行)件数を取得します。 |
GetDataId | データ参照IDを取得します。 |
GetDataValue | データ値を取得します。 |
GetInfo | 任意の情報を文字列で取得します。 |
GetLastErrorCode | 最後のメソッド/プロパティ呼び出しで発生したエラーコードを取得します。 |
GetLastErrorMsg | 最後のメソッド/プロパティ呼び出しで発生したエラーメッセージを取得します。 |
GetPageCount | ページ数を取得します。 |
GetPageNo | 現在アクティブなページを取得します。(表示中のページ) |
GetOption | ウインドウや表示に関するオプション値を取得します。 |
GetPrintOption | 印刷オプション値を取得します。 |
GetVariable | 変数値を取得します。 |
GetVariableM | 変数値(画像)をファイルに取得します。 |
GetVersionInfo | バージョン情報を取得します。 |
Import | データを設定します。 |
ItemScript | 任意のアイテムのプロパティの一部をスクリプトを使って編集します。 |
Open | 帳票ファイル/印刷イメージファイルを開きます。 |
PrintOut | 帳票を印刷します。 |
ReportTitle | Open中の帳票とタイトルを設定します。 |
Save | 帳票を保存します。 |
SearchDataX | データのフィールド(列)名を取得します。 |
SetDataValue | データ値を設定します。 |
SetFontFile | 外字フォントファイルを指定します。 |
SetErrorMode | エラーが発生した場合のエラー処理を選択します。 |
SetPageNo | アクティブなページを設定します。 |
SetOption | ウインドウや表示に関するオプション値を設定します。 |
SetOptions | ウインドウや表示に関するオプションを設定します。 |
SetPrintHistory | 印刷履歴の設定を行います。 |
SetPrintOption | 印刷オプション値を設定します。 |
SetPrintOptionId | 印刷オプションIDを設定し、印刷オプションを入力します。 |
SetPrintOptions | 印刷オプションを設定します。 |
SetVariable | 変数値を設定します。 |
SetVariableM | 変数値(画像)をファイルから設定します。 |
Title | タイトルを設定します。 |
COM専用のメソッドです。
メソッド | 説明 |
---|---|
ShowWindow | ウインドウの表示・非表示を制御します。 |
Visible | ウインドウの表示・非表示を制御します。 |
ActiveX専用のメソッドです。
メソッド | 説明 |
---|---|
DoModal | 別ウインドウ(子ダイアログ)で帳票を表示します。 |
WaitForInitializeObject | WFRのオブジェクトの生成完了を待機します。 |
メソッドの詳細です。
複数の帳票を開くための準備をします。
追加できる帳票数に制限はありません。(メモリ/ディスク容量に空きがある限り追加できます)
<構文>
obj.AddReport( ) As Long |
<引数>
なし
<戻り値>
エラーコードを戻します。正常終了した場合は 0 が戻ります。
<使用例>
obj = CreateObject("Wfr.Preview.1") '---------- obj.Open("c:\sample1.wfr") obj.Import("Data1", 0, "c:\sample1.csv") '---------- obj.AddReport() obj.Open("c:\sample2.wfr") obj.Import("Data1", 0, "c:\sample2.csv") '---------- obj.AddReport() obj.Open("c:\sample3.wfr") obj.Import("Data1", 0, "c:\sample3.csv") '---------- obj.Create() obj.PrintOut() obj.Close() |
'印刷イメージファイル(Type2)を作成 obj = CreateObject("Wfr.Preview.1") '---------- obj.Open("c:\sample1.wfr") obj.Import("Data1", 0, "c:\sample1.csv") '---------- obj.AddReport() obj.Open("c:\sample2.wfr") obj.Import("Data1", 0, "c:\sample2.csv") '---------- obj.AddReport() obj.Open("c:\sample3.wfr") obj.Import("Data1", 0, "c:\sample3.csv") '---------- obj.Create() obj.Save(0, "c:\image.wfi") obj.Close() |
帳票を閉じます。
<構文>
obj.Close( ) As Long |
<引数>
なし
<戻り値>
0
<使用例>
obj = CreateObject("Wfr.Preview.1") obj.Open("c:\sample.wfr") obj.Import("Data1", 0, "c:\sample.csv") obj.Create() obj.PrintOut () obj.Close() |
設定されている情報から帳票出力イメージを作成します。
※
帳票を画面表示せずに、PrintOutメソッドやSaveメソッド、GetBinaryImageメソッドを実行する場合は、Createメソッドを実行する必要はありません。(v1.1以降)
<構文>
obj.Create( ) As Long |
<引数>
なし
<戻り値>
エラーコードを戻します。正常終了した場合は 0 が戻ります。
<使用例1>
obj = CreateObject("Wfr.Preview.1") obj.Open("c:\sample.wfr") obj.Import("Data1", 0, "c:\sample.csv") obj.Create() obj.Visible = True |
<使用例2> Createメソッドの実行は必要ありません。
obj = CreateObject("Wfr.Preview.1") obj.Open("c:\sample.wfr") obj.Import("Data1", 0, "c:\sample.csv") obj.PrintOut(0) |
データスクリプトを実行します。レコードの抽出や並べ替えが行えます。
<構文>
obj.DataScript( data_name As String, script_name As String, script As Strint ) As Long |
<引数>
引数 | 説明 | ||||||
---|---|---|---|---|---|---|---|
data_name | データ名(あるいはデータ番号)を指定します。 データ番号で指定する場合は先頭に「#」(シャープ)を付けます。 ここで示すデータ名とは、エディタで使用している名称となります。データ名はプロパティ等で参照・変更できます。 データ番号で指定する場合は、エディタのデータ構成の順に1から指定します。 (例: #1 ) |
||||||
script_name | スクリプト名を指定します。
|
||||||
script | 実行するスクリプトを指定します。 「スクリプト」参照。 |
<戻り値>
失敗すると0以外の値を戻します。
<使用例-Where>
'Field1の値が"A"のレコードだけを使います。 obj.Open("c:\sample1.wfr") obj.Import("Data1", 0, "c:\sample1.csv") obj.DataScript("Data1", "Where", "Get(""Field1"") == ""A""") obj.Create |
<使用例-Order>
'Field1の値が小さい順に並べ替えます。 obj.Open("c:\sample1.wfr") obj.Import("Data1", 0, "c:\sample1.csv") obj.DataScript("Data1", "Order", "Order(3, ""Field1"")") obj.Create() |
データをファイルに出力します。
<構文>
obj.ExportFile( name As String, type As Long, file As String, option As String="", image_folder As String="" ) As Long |
<引数>
引数 | 説明 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name | 設定するデータ名(あるいはデータ番号)を指定します。 データ番号で指定する場合は先頭に「#」(シャープ)を付けます。 ここで示すデータ名とは、エディタで使用している名称となります。データ名はプロパティ等で参照・変更できます。 データ番号で指定する場合は、エディタのデータ構成の順に1から指定します。 (例: #1 ) |
||||||||||||
type | 設定するデータの形式を指定します。 CSVファイルへの出力だけがサポートされています。 0 以外の値を指定しないでください。
|
||||||||||||
file | 出力先ファイル名を完全パスで指定します。 ※ ファイルが存在する場合は上書きされます。 |
||||||||||||
option | オプションを指定します。
複数のオプションを指定する場合は、「;」(セミコロン)で区切り複数の書式を記述します。 <type が 0 の場合>
|
||||||||||||
image_folder | このパラメータは予約されています。空("")の文字列を指定してください。 |
なし
<戻り値>
エラーコードを戻します。正常終了した場合は 0 が戻ります。
<使用例>
obj = CreateObject("Wfr.Preview.1") obj.Open("c:\sample.wfr") obj.ExportFile("Data1", 0, "c:\sample.csv") |
データを文字列で取得します。
<構文>
obj.ExportStr( name As String, type As Long, option As String="", image_folder As String="" ) As String |
<引数>
引数 | 説明 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name | 設定するデータ名(あるいはデータ番号)を指定します。 データ番号で指定する場合は先頭に「#」(シャープ)を付けます。 ここで示すデータ名とは、エディタで使用している名称となります。データ名はプロパティ等で参照・変更できます。 データ番号で指定する場合は、エディタのデータ構成の順に1から指定します。 (例: #1 ) |
||||||||||||
type | 設定するデータの形式を指定します。 CSVファイルへの出力だけがサポートされています。 0 以外の値を指定しないでください。
|
||||||||||||
option | オプションを指定します。
複数のオプションを指定する場合は、「;」(セミコロン)で区切り複数の書式を記述します。 <type が 0 の場合>
|
||||||||||||
image_folder | このパラメータは予約されています。空("")の文字列を指定してください。 |
<戻り値>
正常終了した場合はデータ文字列が戻ります。
失敗すると空("")の文字列が戻ります。
エラーコードを取得するには GetLastErrorCode/GetLastErrorMsgメソッドを使用します。
<使用例>
obj = CreateObject("Wfr.Preview.1") obj.Open("c:\sample.wfr") data_str = obj.ExportStr("Data1", 0) |
帳票をメモリに保存し取得します。
ASP等を使って帳票イメージを出力する場合に使用します。
「ASPサンプル」参照。
AddReport 等を使って複数の帳票が開かれている場合、mode の指定は無視され常に印刷イメージファイル(Type2)形式で保存されます。
「保存できるファイル形式」
<構文>
obj.GetBinaryImage(type As Long) As ByteArray |
<引数>
引数 | 説明 | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
type | 保存形式を指定します。
|
<戻り値>
バイトの配列を戻します。
<使用例1>
<%@Language="VBScript"%> <% Dim wfrPrv As Object wfrPrv = CreateObject("Wfr.Preview.1") wfrPrv.Open("c:\sample.wfr") wfrPrv.Import("Data1", 0, "c:\sample.csv") image = wfrPrv.GetBinaryImage(0) Response.ContentType="application/octer-stream" Response.BinaryWrite image %> |
<使用例2-フォント情報を埋め込む>
'ASP中で起動される実行モジュールはフォントへのアクセスが行えません。 'あらかじめ使用する全てのフォント・コードから外字フォントファイルを作成しておき、 '指定する必要があります。 <%@Language="VBScript"%> <% Dim wfrPrv As Object wfrPrv = CreateObject("Wfr.Preview.1") wfrPrv.Open("c:\sample.wfr") wfrPrv.Import("Data1", 0, "c:\sample.csv") wfrPrv.SetFontFile "c:\sample.wff" image = wfrPrv.GetBinaryImage(4) Response.ContentType="application/octer-stream" Response.BinaryWrite image %> |
データのフィールド(列)数を取得します。
<構文>
obj.GetDataCountX( data_id As Long ) As Long |
<引数>
引数 | 説明 |
---|---|
data_id | 情報を取得したいデータの参照IDを指定します。 参照IDは、GetDataId メソッドを使って取得します。 |
<戻り値>
フィールド(列)数を戻します。
データのレコード(行)件数を取得します。
<構文>
obj.GetDataCountY( data_id As Long ) As Long |
<引数>
引数 | 説明 |
---|---|
data_id | 情報を取得したいデータの参照IDを指定します。 参照IDは、GetDataId メソッドを使って取得します。 |
<戻り値>
レコード(行)件数を戻します。
データ参照IDを取得します。
<構文>
obj.GetDataId( data_name As String, initialize As Long ) As Long |
<引数>
引数 | 説明 |
---|---|
data_name | データ名(あるいはデータ番号)を指定します。 データ番号で指定する場合は先頭に「#」(シャープ)を付けます。 ここで示すデータ名とは、エディタで使用している名称となります。データ名はプロパティ等で参照・変更できます。 データ番号で指定する場合は、エディタのデータ構成の順に1から指定します。 (例: #1 ) |
initialize | データの初期化有無を指定します。 0 を指定するとデータは初期化されません。 1 を指定するとデータ値が全て初期化(破棄)されます。 |
<戻り値>
データ参照IDを返します。
失敗すると負の値を戻します。
<使用例>
Wfrc1.Open("c:\sample\sample.wfr") data_id = Wfrc1.GetDataId("Data1", 1) Wfrc1.SetDataValue(data_id, 0, 2, "データ値を指定することができます。!") Wfrc1.Create() |
データ値を取得します。
<構文>
obj.GetDataValue( data_id As Long, x As Long, y As Long) As Long |
<引数>
引数 | 説明 |
---|---|
data_id | 情報を取得したいデータの参照IDを指定します。 参照IDは、GetDataId メソッドを使って取得します。 |
x | フィールド位置(座標)を指定します。(0〜) |
y | レコード位置(座標)を指定します。(0〜) |
<戻り値>
データ値を戻します。
失敗すると空("")の文字列を戻します。
<使用例>
s = Wfrc1.GetDataValue(data_id, 0, 2) |
任意の情報を文字列で取得します。
<構文>
obj.GetInfo( info_name As String) As String |
<引数>
引数 | 説明 | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
info_name | 取得する情報名を指定します。 <用紙関連の情報> 用紙関連の情報取得はCreateメソッド実行後に行う必要があります。 用紙関連の情報はアンダーバー('_')で区切ることでページ数を指定することができます。 省略した場合は先頭ページ(1ページ)の用紙情報を取得します。 (例) 5ページ目の用紙コードを取得 s = Wfrc1.GetInfo("PaperCode_5")
<印刷ページ数>
|
<戻り値>
情報文字列を取得します。
失敗すると空("")の文字列を戻します。
<使用例>
Wfrc1.Open("sample.wfr") Wfrc1.Create() s = Wfrc1.GetInfo("PaperCode") |
最後のメソッド/プロパティ呼び出しで発生したエラーコードを取得します。
GetLastErrorMsg と一致します。
<構文>
obj.GetLastErrorCode( ) As Long |
<引数>
なし
<戻り値>
エラーコードを戻します。エラーが発生していない場合は 0 が戻ります。
最後のメソッド/プロパティ呼び出しで発生したエラーメッセージを取得します。
GetLastErrorCode と一致します。
<構文>
obj.GetLastErrorMsg( ) As String |
<引数>
なし
<戻り値>
エラーメッセージを戻します。エラーが発生していない場合は 空の文字列 が戻ります。
<使用例>
「実行エラー」参照。
ページ数を取得します。
<構文>
obj.GetPageCount( ) As Long |
<引数>
なし
<戻り値>
ページ数が戻ります。
現在アクティブなページを取得します。(表示中のページ)
<構文>
obj.GetPageNo( ) As Long |
<引数>
なし
<戻り値>
ページ番号が戻ります。
ウインドウや表示に関するオプション値を取得します。
詳細は「表示オプション」を参照。
<構文>
obj.GetOption(name As String) As String |
<引数>
引数 | 説明 |
---|---|
name | 取得したいオプション名を指定します。 |
<戻り値>
オプション値が戻ります。
印刷オプション値を取得します。
詳細は「印刷オプション」を参照。
<構文>
obj.GetPrintOption(name As String) As String |
<引数>
引数 | 説明 |
---|---|
name | 取得したいオプション名を指定します。 |
<戻り値>
オプション値が戻ります。
変数値を取得します。
<構文>
obj.GetVariable(name As String) As String |
<引数>
引数 | 説明 |
---|---|
name | 取得したい変数名を指定します。 |
<戻り値>
変数値が戻ります。
変数値(画像)をファイルに取得します。
file に指定したファイル名に無条件に保存されます。
<構文>
obj.GetVariable(name As String, file As String) As Long |
<引数>
引数 | 説明 |
---|---|
name | 取得したい変数名を指定します。 |
file | 画像を保存するファイル名を完全パスで指定します。 |
<戻り値>
エラーコードを戻します。正常に終了した場合は 0 が戻ります。
バージョン情報を取得します。
<構文>
obj.GetVersionInfo(level As Long) As Long |
<引数>
引数 | 説明 | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
level | 取得するバージョンレベルを指定します。
|
<戻り値>
バージョン番号を取得します。
データを設定します。
※
このメソッドは Create/PrintOut/Save メソッドの前に実行する必要があります。
<構文>
obj.Import( name As String, type As Long, info1 As String, info2 As String="", option As String="", image_folder As String="" ) As Long |
<引数>
引数 | 説明 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name | 設定するデータ名(あるいはデータ番号)を指定します。 データ番号で指定する場合は先頭に「#」(シャープ)を付けます。 ここで示すデータ名とは、エディタで使用している名称となります。データ名はプロパティ等で参照・変更できます。 データ番号で指定する場合は、エディタのデータ構成の順に1から指定します。 (例: #1 ) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type | 設定するデータの形式を指定します。
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
info1 | <type が 0 の場合> CSVファイル名を完全パスで指定します。(URLパスの指定も可能です) URLパスを指定する場合、URLパスの前に以下のキーワードを記述することでダウンロードするモードを指定することができます。
<type が 1 の場合> データベース接続情報を指定します。 接続情報はデータベース毎に異なります。各データベースの仕様をご覧ください。 「データリンクプロパティ」を使って作成することもできます。 <「データリンクプロパティ」の表示方法>
<type が 2 の場合> MDBファイル名を完全パスで指定します。 <type が 3 の場合> Oracleデータベース名を指定します。 <type が 12 の場合> Accessデータベース(*.mdb/*.accdb)を完全パスで指定します。 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
info2 | <type が 0 の場合> 使用されません。 <type が 1,2,3,12 の場合> テーブル名(あるいはクエリー)を指定します。 抽出条件等を指定することもできます。(データベースにより記述方法等に違いがあります) 例: 2005/04/01 〜 2006/04/01 までの売上を表示 SELECT ALL * FROM 売上一覧 WHERE 販売日>=#2005/04/01# and 販売日<#2006/04/01# |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
option | オプションを指定します。
複数のオプションを指定する場合は、「;」(セミコロン)で区切り複数の書式を記述します。 <type が 0 の場合>
<type が 1 の場合>
<type が 2,3 の場合>
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
image_folder | 画像ファイルが格納されているフォルダを指定します。 ※ WFR2016 version 3.0.0.4以降は、完全パス以外を指定した場合はカレントパスからの相対パスとなります。 |
<戻り値>
エラーコードを戻します。正常終了した場合は 0 が戻ります。
<使用例>
obj = CreateObject("Wfr.Preview.1") obj.Open("c:\sample.wfr") obj.Import("Data1", 0, "c:\sample.csv") obj.Create() obj.PrintOut() |
obj = CreateObject("Wfr.Preview.1") obj.Open("c:\sample.wfr") obj.Import("Data1", 0, "<DM1>http://www.../sample.csv") obj.Create() obj.PrintOut() |
obj = CreateObject("Wfr.Preview.1") obj.Open("c:\sample.wfr") obj.Import("Data1", 0, "c:\sample.csv", "", "Field=off") obj.Create() obj.PrintOut() |
obj = CreateObject("Wfr.Preview.1") obj.Open("c:\sample.wfr") obj.Import("Data1", 0, "c:\sample.csv", "", "Sep=[TAB];Quot=[NULL];LineFeed=[CRLF]") obj.Create() obj.PrintOut() |
obj = CreateObject("Wfr.Preview.1") obj.Open("c:\sample.wfr") obj.Import("Data1", 1, "Provider=Microsoft.Jet.OLEDB.4.0;Data Source=c:\sample.mdb", "SELECT * FROM 売上一覧") obj.Create() obj.PrintOut() |
obj = CreateObject("Wfr.Preview.1") obj.Open("c:\sample.wfr") obj.Import("Data1", 2, "c:\sample.mdb", "売上一覧") obj.Create() obj.PrintOut() |
obj = CreateObject("Wfr.Preview.1") obj.Open("c:\sample.wfr") obj.Import("Data1", 3, "ORADB", "EMP","User=scott;Passwd=tiger") obj.Create() obj.PrintOut() |
任意のアイテムのプロパティの一部をスクリプトを使って編集します。
※
このメソッドは Create/PrintOut/Save メソッドの前に実行する必要があります。
<構文>
obj.ItemScript( script As String ) As Long |
<引数>
引数 | 説明 |
---|---|
script | 実行するスクリプトを指定します。 SetProperty スクリプトと同様の操作が行えます。(データ値や変数値参照は不可) 詳細は「スクリプト」参照。 「Wonderful Report 2000」のSetItemPropery との互換機能を備えています。 WFR2000の帳票に対して操作する場合はスクリプトの代わりに次の書式を記載します。 <書式> [WFR2000],<itemName>,<valueName>,<newValue> ※ [WFR2000]は固定値です。 <itemName><valueName><newValue>については、 「Wonderful Report 2000」のヘルプでSetItemProperyメソッドの説明を参照ください。 WFR2000/WFR2005の双方の帳票を対象に指定する場合は、 <itemName> を常に AllItems にする必要があります。 |
<戻り値>
失敗すると0以外の値を戻します。
<使用例>
'全アイテムのフォントを MS UI Gothic に変更します。 obj.Open("c:\sample1.wfr") obj.Import("Data1", 0, "c:\sample1.csv") obj.ItemScript("_item.font_name=""MS UI Gothic""") obj.Create() |
<使用例>
'アイテムID=0x00010008 の文字の色を赤に変更します。 obj.Open("c:\sample1.wfr") obj.Import("Data1", 0, "c:\sample1.csv") obj.ItemScript("if (_item.id != 0x00010008) return; _item.font_color=RGB(255,0,0);") obj.Create() |
<使用例-WFR2000 互換>
'MS 明朝を使っているアイテムのフォントを MS UI Gothic に変更します。 obj.Open("c:\sample1.wfr") obj.Import("Data1", 0, "c:\sample1.csv") obj.ItemScript("[WFR2000],AllItems,FontName=MS 明朝,MS UI Gothic") obj.Create() |
帳票ファイル/印刷イメージファイルを開きます。
URLパスを指定する場合、URLパスの前に以下のキーワードを記述することでダウンロードするモードを指定することができます。
キーワード | 説明 |
---|---|
<DM0> | ファイルをキャッシュします。 |
<DM1> | ファイルをキャッシュしません。(デフォルト値) クライアントコンピュータにプロキシサーバーの設定がされている場合、プロキシサーバーでのキャッシュも行われません。この場合でもプロキシサーバーを経由してファイルをダウンロードします。 |
<DM2> | Webサーバーから直接ファイルをダウンロードします。 クライアントコンピュータにプロキシサーバーの設定がされていても、プロキシサーバーを経由せずにファイルをダウンロードします。 |
<構文>
obj.Open( file As String, user As String="", passwd As String="" ) As Long |
<引数>
引数 | 説明 |
---|---|
file | 帳票ファイル(または印刷イメージファイル)を指定します。 |
user | セキュリティで保護されている帳票を開く場合に指定します。 |
passwd | セキュリティで保護されている帳票を開く場合に指定します。 |
<戻り値>
エラーコードを戻します。正常終了した場合は 0 が戻ります。
<使用例>
obj = CreateObject("Wfr.Preview.1") obj.Open("c:\sample.wfr") obj.Import("Data1", 0, "c:\sample.csv") obj.Create() obj.Visible = True |
obj = CreateObject("Wfr.Preview.1") obj.Open("c:\sample.wfr", "admin", "9876") obj.Import("Data1", 0, "c:\sample.csv") obj.Create() obj.Visible = True |
obj = CreateObject("Wfr.Preview.1") obj.Open("<DM1>http://www.../sample.wfr") obj.Import("Data1", 0, "<DM2>http://www.../sample.csv") obj.Create() obj.Visible = True |
帳票を印刷します。
※
帳票の印刷設定によっては、印刷ダイアログで「OK」ボタンを押下すると帳票毎に印刷オプションが保存され、次回以降のデフォルト値として使用されます。この場合、通常使うプリンターに印刷したい場合等は明示的に設定を初期化する必要があります。
<初期化の例>
obj.SetPrintOption("Init", "all")
obj.SetPrintOptions("Init=all")
obj.PrintOut(0, "", "Init=all")
<構文>
obj.PrintOut( mode As Long=0, printer As String="", option As String="") As Long |
<引数>
引数 | 説明 | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
mode | 印刷モードを指定します。 下記の<方法>と<モード>を合わせた値を指定します。 <方法>
<モード>
|
||||||||||||||||||||||||||||
printer | 印刷するプリンター名を指定します。 省略した場合は option で指定したプリンター(またはデフォルトのプリンター)が選択されます。 |
||||||||||||||||||||||||||||
option | 印刷オプションを指定します。「印刷オプション」参照。 |
<戻り値>
エラーコードを戻します。正常終了した場合は 0 が戻ります。
エラーコード | 内容 |
---|---|
-100 | 印刷がキャンセルされました。 |
-101 | 原因不明のエラーが発生しました。 |
-102 | 印刷可能なページはありません。 |
-103 | プリンターを開くことができませんでした。 |
-104 | プリンターが指定されていません。 |
-105 | ページ範囲の指定に誤りがあります。 |
-106 | 印刷開始処理でエラーが発生しました。 |
-107 | 印刷終了処理でエラーが発生しました。 |
-108 | 印刷処理でエラーが発生しました。 |
-109 | 印刷ダイアログでキャンセルされました。 |
-110 | 印刷開始処理でエラーが発生しました。出力ファイル名が指定されていません。 |
-111 | 印刷開始処理でエラーが発生しました。出力用ハンドルの生成に失敗しました。 |
-112 | 印刷開始処理でエラーが発生しました。ファイルの作成に失敗しました。 |
-113 | 印刷開始処理でエラーが発生しました。印刷ジョブの開始で失敗しました。 |
-114 | 印刷終了処理でエラーが発生しました。出力ファイル名が指定されていません。 |
-115 | 印刷終了処理でエラーが発生しました。PostScript ファイルの操作中にエラーが発生しました。 |
-116 | 印刷終了処理でエラーが発生しました。PDFの作成に失敗しました。 |
-117 | 仕分印刷中にエラーが発生しました。 |
-118 | 仕分リストファイルが指定されていません。 |
-119 | 仕分リストファイルを開くことができません。 |
-120 | 仕分リストファイルの入力に失敗しました。必要な項目が存在しません。 |
-121 | 仕分リストファイルの入力に失敗しました。認識できないモードが指定されています。 |
-122 | FAX接続用モジュールのロードに失敗しました。 |
-123 | 「まいとーくFAX」への接続に失敗しました。 |
-124 | 「まいとーくFAX」の初期化中にエラーが発生しました。 |
-301 | PdfDistiller に接続することができません。 |
-302 | PDFファイルの生成に失敗しました。 |
<使用例>
'標準のプリンターに印刷 obj = CreateObject("Wfr.Preview.1") obj.Open("c:\sample.wfr") obj.Import("Data1", 0, "c:\sample.csv") obj.SetPrintOption("Init", "all") obj.PrintOut() |
'印刷(ダイアログ表示) '前回印刷した設定を再利用 obj = CreateObject("Wfr.Preview.1"); obj.Open("c:\sample.wfr", "admin", "9876") obj.Import("Data1", 0, "c:\sample.csv") obj.PrintOut(1) |
'「まいとーくFAXと連携し」FAXに送信 obj = CreateObject("Wfr.Preview.1") obj.Open("c:\sample.wfr") obj.Import("Data1", 0, "c:\sample.csv") obj.PrintOut(30, "", "Init=all;FaxName=山田;FaxAreaNumber=03;FaxNumber=1234-5678") |
'用紙別印刷(ダイアログ表示) '前回印刷した設定を再利用 obj = CreateObject("Wfr.Preview.1") obj.Open("c:\sample.wfr") obj.Import("Data1", 0, "c:\sample.csv") obj.PrintOut(41) |
'仕分印刷(ダイアログ表示) obj = CreateObject("Wfr.Preview.1") obj.Open("c:\sample.wfr") obj.Import("Data1", 0, "c:\sample.csv") obj.PrintOut(51, "", "SortListFile='c:\sample.txt'") |
帳票タイトルを設定します。
ReportTitleキーワードで設定した値は、ウインドウタイトルや印刷ジョブ名として使用されることはありません。
マルチ帳票での「目次」や「用紙別印刷」でブック名として使用されます。
<構文>
obj.Title As String |
<使用例>
obj.ReportTitle = "SAMPLE" |
帳票を保存します。
AddReport 等を使って複数の帳票が開かれている場合、mode の指定は無視され常に印刷イメージファイル(Type2)形式で保存されます。
「保存できるファイル形式」
<構文>
obj.Save(mode As Long, file As String) As Long |
<引数>
引数 | 説明 | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
mode | 保存形式を指定します。
|
||||||||||
file | 保存するファイル名を完全パスで指定します。 |
<戻り値>
エラーコードを戻します。正常終了した場合は 0 が戻ります。
<使用例>
obj = CreateObject("Wfr.Preview.1") obj.Open("c:\sample.wfr") obj.Import("Data1", 0, "c:\sample.csv") obj.Save(0, "c:\sample.wfi") |
フィールド名から列番号を取得します。
<構文>
obj.SearchDataX(data_id As Long, field_name As String) As Long |
<引数>
引数 | 説明 |
---|---|
data_id | 情報を取得したいデータの参照IDを指定します。 参照IDは、GetDataId メソッドを使って取得します。 |
field_name | フィールド名を指定します。 |
<戻り値>
フィールド列番号を戻します。
失敗すると負の値を戻ります。
エラーコードを取得するには GetLastErrorCode/GetLastErrorMsgメソッドを使用します。
データ値を設定します。
存在しない行(レコード)を指定すると自動的に拡張されます。
<構文>
obj.SetDataValue( data_id As Long, x As Long, y As Long, value As String) As Long |
<引数>
引数 | 説明 |
---|---|
data_id | 情報を取得したいデータの参照IDを指定します。 参照IDは、GetDataId メソッドを使って取得します。 |
x | 列(フィールド)位置を指定します。(0〜) |
y | 行(レコード)位置を指定します。(0〜) |
value | 値を指定します。 |
<戻り値>
成功すると 0 を戻します。
失敗すると 負の値を戻します。
<使用例>
data_id = obj.GetDataId("Data1") obj.SetDataValue(data_id, 0, 2, "ABC") |
外字フォントファイルを指定します。
外字フォントファイルを使用することで外字や特殊なフォントであっても、システム環境に依存することなく表示・印刷することができます。
※
印刷イメージファイルに対しては外字フォントファイルを設定できません。設定しても無視されます。
SetFontFileメソッドより先にCreateメソッドを実行すると正しく帳票が作成されない場合があります。
「外字」「外字フォントファイル」「外字フォントファイルの作成」参照。
※
URLパスを指定してフォントファイルを指定する場合、<DM0>を指定してファイルをキャッシュするように設定することをお勧めします。この設定を行うことで1度ダウンロードしたフォントファイルは次回以降のダウンロード時間を短縮することができます。
<構文>
obj.SetFontFile( font_file As String) As Long |
<引数>
引数 | 説明 |
---|---|
font_file | 外字フォントファイルを指定します。 |
<戻り値>
成功すると 0 を戻します。
失敗すると 負の値を戻します。
<使用例1>
obj = CreateObject("Wfr.Preview.1") obj.SetFontFile("c:\sample.wff") obj.Open("c:\sample.wfr") obj.Import("Data1", 0, "c:\sample.csv") obj.Save(0, "c:\sample.wfi") |
<使用例2 - URLパスでフォントファイルを指定>
obj.SetFontFile("<DM0>http://www..../sample.wff") |
メソッドまたはプロパティの実行中にエラーが発生した場合の、エラー処理を選択します。
<構文>
obj.SetErrorMode( mode As Long, level As Long=0) |
<引数>
引数 | 説明 | ||||||
---|---|---|---|---|---|---|---|
mode | エラー発生時の処理を選択します。
|
||||||
level | エラーレベルを設定します。
|
<戻り値>
なし。
<使用例>
'エラー処理を例外で行う例 Private Sub Command2_Click() Dim wfrPrv As Object Try wfrPrv = CreateObject("Wfr.Preview.1") Try wfrPrv.SetErrorMode(1) wfrPrv.Open("c:\sample.wfr") wfrPrv.Import("Data1", 0, "c:\sample.csv") wfrPrv.Create() wfrPrv.Visible = True Catch ex As Exception MessageBox.Show(ex.Message) End Try System.Runtime.InteropServices.Marshal.ReleaseComObject(wfrPrv) Catch ex As Exception MessageBox.Show(ex.Message) End Try End Sub |
アクティブなページを設定します。
<構文>
obj.SetPageNo(no As Long) |
<引数>
引数 | 説明 |
---|---|
no | ページ番号を指定します。(1〜) |
<戻り値>
なし。
ウインドウや表示に関するオプション値を設定します。
詳細は「表示オプション」を参照。
<構文>
obj.SetOption(name As String, value As String) As Long |
<引数>
引数 | 説明 |
---|---|
name | 設定したいオプション名を指定します。 |
value | 設定する値を指定します。 |
エラーコードを戻します。正常終了した場合は 0 が戻ります。
ウインドウや表示に関するオプションを設定します。
詳細は「表示オプション」を参照。
<構文>
obj.SetOptions(option As String) As Long |
<引数>
引数 | 説明 |
---|---|
option | 設定したいオプションを指定します。 |
<戻り値>
エラーコードを戻します。正常終了した場合は 0 が戻ります。
印刷履歴に関する情報を設定します。
※
このメソッドで設定した値は、他のプロパティ/メソッドとは異なり、オブジェクトが破棄されるまで有効となります。
<構文>
obj.SetPrintHistory(folder As String, user_data As String="") As Long |
<引数>
引数 | 説明 | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
mode | 履歴保存モード(フォントの埋め込み)を指定します。 ※ 文字描画方法がv1.0 互換モードの場合、フォントを埋め込むと比率調整を行っている文字が印刷結果と同じになりません。 「互換オプション」 ダイアログで切り替えが可能です。
|
||||||||||
folder | 履歴を保存するフォルダを完全パスで指定します。 ""(空文字)を指定すると環境設定の内容に従い履歴を保存します。(履歴の保存有無も含め) "Disable"を指定すると履歴の保存は行いません。 |
||||||||||
user_data | 印刷履歴ツールの一覧や詳細ウインドウに表示する任意のデータ(文字列)を指定することができます。 <構文>
情報名や値に「=」(イコール)、「 」(スペース)、等が含まれる場合は、「'」(シングルクォーテーション)で囲みます。 <例> 担当者='山田 太郎';部署=経理課 |
<戻り値>
エラーコードを戻します。正常終了した場合は 0 が戻ります。
<使用例>
obj = CreateObject("Wfr.Preview.1") obj.SetPrintHistory(0, "", "担当者='山田 太郎';部署=経理課") obj.Open("c:\sample.wfr") obj.Import("Data1", 0, "c:\sample.csv") obj.PrintOut() |
印刷オプション値を設定します。
詳細は「印刷オプション」を参照。
※
このメソッドは Open メソッドの後に実行する必要があります。
<構文>
obj.SetPrintOption(name As String, value As String) As Long |
<引数>
引数 | 説明 |
---|---|
name | 設定したいオプション名を指定します。 |
value | 設定する値を指定します。 |
<戻り値>
エラーコードを戻します。正常終了した場合は 0 が戻ります。
<使用例>
'用紙、ページ範囲、トレイを個別に設定 obj.SetPrintOption("Paper", "A4") obj.SetPrintOption("Range", "3-5,7") obj.SetPrintOption("Tray", "カセット1") obj.PrintOut(0) 'FAXに送信 obj.SetPrintOption("FaxName","あいうえお株式会社") obj.SetPrintOption("FaxAreaNumber","03") obj.SetPrintOption("FaxNumber","1234-5678") obj.PrintOut(30) |
印刷オプションIDを設定します。
このメソッドで印刷オプションID を指定した場合、「印刷設定」での指定は無視されます。
マルチ帳票(AddReportを使用した帳票)で印刷オプションを再利用する場合は、このメソッドで
オプションIDを指定する必要があります。
このメソッドで指定したオプションID は Save メソッドで帳票情報として保存され利用されます。
※
このメソッドは Open メソッドの後に実行する必要があります。
<構文>
obj.SetPrintOptionId(opid As String) As Long |
<引数>
引数 | 説明 |
---|---|
opid | 設定したい印刷オプションIDを指定します。 |
<戻り値>
name で指定した印刷オプションIDがシステムに登録済みで、印刷オプションの入力が行われた場合は 1 を戻します。その他の場合は 0 を戻します。
<使用例>
'印刷オプションID を指定。 obj.Open("c:\sample1.wfr") obj.AddReport() obj.Open("c:\sample2.wfr") obj.Create() obj.SetPrintOptionId("TERASOFT_OPTION1") '印刷オプションID を指定して帳票イメージファイルを作成。 obj.Open("c:\sample1.wfr") obj.AddReport() obj.Open("c:\sample2.wfr") obj.SetPrintOptionId("TERASOFT_OPTION1") obj.Save(0, "c:\sample.wfr") |
印刷オプションを設定します。
詳細は「印刷オプション」を参照。
※
このメソッドは Open メソッドの後に実行する必要があります。
<構文>
obj.SetPrintOptions(option As String) As Long |
<引数>
引数 | 説明 |
---|---|
option | 設定したいオプションを指定します。 |
<戻り値>
エラーコードを戻します。正常終了した場合は 0 が戻ります。
<使用例>
'用紙、トレイを一括設定 obj.SetPrintOptions("Paper=A4;Tray=カセット2") obj.PrintOut(0) 'FAXに送信 obj.SetPrintOptions("FaxName='あいうえお株式会社';FaxAreaNumber=03;FaxNumber=1234-5678") obj.PrintOut(30) |
変数値を設定します。
※
このメソッドは Create/PrintOut/Save メソッドの前に実行する必要があります。
<構文>
obj.SetVariable(name As String, value As String) As Long |
<引数>
引数 | 説明 |
---|---|
name | 設定したい変数名を指定します。 |
value | 設定する値を指定します。 |
<戻り値>
エラーコードを戻します。正常終了した場合は 0 が戻ります。
変数値(画像)をファイルから設定します。
※
このメソッドは Create/PrintOut/Save メソッドの前に実行する必要があります。
<構文>
obj.SetVariable(name As String, file As String) As Long |
<引数>
引数 | 説明 |
---|---|
name | 取得したい変数名を指定します。 |
file | 画像を取得するファイル名を完全パスで指定します。 指定できる画像形式は 非圧縮BMPと標準JPGです。 |
<戻り値>
エラーコードを戻します。正常に終了した場合は 0 が戻ります。
タイトルを設定します。
ここで指定された文字列がウインドウタイトルやスプールタイトルとして使用されます。
<構文>
obj.Title As String |
<値>
タイトル文字列を設定・参照します。
<使用例>
obj = CreateObject("Wfr.Preview.1") obj.Open("c:\sample.wfr") obj.Import("Data1", 0, "c:\sample.csv") obj.Title = "SAMPLE" obj.Create() obj.Visible = True |
ウインドウの表示・非表示を制御します。
※
RemoteAppからCOMを使ってバックグラウンド印刷を実行すると「印刷中」ダイアログがRemoteAppのセッション終了まで残ることがあります。
この場合は、ShowWindows(2) を使いPreview画面をアイコン表示にして印刷を実行することで問題を回避することができます。(version
3.0.0.128以降)
<構文>
obj.ShowWindow(mode As Long) As Long |
<引数>
引数 | 説明 | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
mode | 表示モードを指定します。
|
<戻り値>
エラーコードを戻します。正常に終了した場合は 0 が戻ります。
<使用例>
obj = CreateObject("Wfr.Preview.1") obj.Open("c:\sample.wfr") obj.Import("Data1", 0, "c:\sample.csv") obj.Create() obj.ShowWindow(3) |
<使用例>Previewをアイコン表示でバックグランド印刷
obj = CreateObject("Wfr.Preview.1") obj.Open("c:\sample.wfr") obj.Import("Data1", 0, "c:\sample.csv") obj.Create() obj.ShowWindow(2) obj.PrintOut() obj.ShowWindow(0) System.Runtime.InteropServices.Marshal.ReleaseComObject(obj) obj = Nothing |
ウインドウの表示・非表示を制御します。
<構文>
obj.Visible As Bool |
<値>
True を指定するとウインドウが表示されます。
False を指定するとウインドウが非表示になります。
<使用例>
obj = CreateObject("Wfr.Preview.1") obj.Open("c:\sample.wfr") obj.Import("Data1", 0, "c:\sample.csv") obj.Create() obj.Visible = True |
別ウインドウ(子ダイアログ)で帳票を表示します。
※
表示されたダイアログが閉じるまで、元ウインドウは操作不能となります。
<構文>
obj.DoModal(mode As Long) As Long |
<引数>
引数 | 説明 | ||||||
---|---|---|---|---|---|---|---|
mode | 表示モードを指定します。
|
<戻り値>
常に 0 を戻します。
<使用例>
objWfr.Open("d:\tp\sample.wfr") objWfr.Import("Data1", 0, "d:\tp\sample.csv") objWfr.Create() objWfr.DoModal(1) |
WFRのオブジェクトの生成完了を待機します。
このメソッドは、HTMLのbodyタグからonLoadイベント関数中でWFRのオブジェクトの生成が完了するのを待機するたに使用します。
<構文>
obj.WaitForInitializeObject(time As Long) As Long |
<引数>
引数 | 説明 |
---|---|
time | タイムアウト時間をミリ秒単位で指定します。0を指定すると生成が完了するまで待機します。 |
<戻り値>
エラーコードを戻します。
正常終了した場合は 0 が戻ります。
タイムアウトで失敗した場合は -1 が戻ります。
<使用例>
Wfrc1.WaitForInitializeObject 0 |