3-4-4 文書関連

文書関連の操作を行うためのAPIについて記載します。

機能 メソッド
文書情報を取得する GetDocument
文書情報を取得する GetDocuments
文書情報を取得する GetDocumentsWithIndexes
指定範囲の文書情報の一覧を取得する GetDocumentsWithRange
文書数を取得する GetDocumentCount
文書管理番号を取得する GetDocNums
指定範囲の文書管理番号を取得する GetDocNumsWithRange
印刷を実行する PrintToServerPrinter
コメントを指定して印刷を実行する PrintToServerPrinterWithComments
複数文書の印刷を実行する PrintsToServerPrinter
コメントを指定して複数文書の印刷を実行する PrintsToServerPrinterWithComments
テスト印刷を実行する TestPrintToServerPrinter
コメントを指定してテスト印刷を実行する TestPrintToServerPrinterWithComments
複数文書のテスト印刷を実行する TestPrintsToServerPrinter
コメントを指定して複数文書のテスト印刷を実行する TestPrintsToServerPrinterWithComments
プリンターグループへ印刷を実行する PrintsToPrinterGroup
印刷を停止する StopDocument
印刷を停止する StopDocuments
印刷を中断する AbortDocument
印刷を中断する AbortDocuments
印刷を再開する RestartDocument
印刷を再開する RestartDocuments
文書を削除する DeleteDocument
プリンターキュー文書情報一覧を取得する GetPrinterQueueDocuments
プリンターキュー文書の優先順位を変更する UpdatePrinterQueueDocument
プリンターキューの優先順位を変更する UpdatePrinterQueueDocuments
停止文書の印刷先を変更する ChangePrinter
印刷データを取得する GetPrintData
プリンタープロパティを指定して印刷データを取得する GetPrintDataWithProperties
プリンタープロパティとコメントを指定して印刷データを取得する GetPrintDataWithPropertiesAndComments
印刷データを生成し、ダウンロードするためのPATH(URL)を取得する GetPrintDataPath
指定プリンタープロパティで作成した印刷データを生成し、ダウンロードのためのPATH(URL)を取得する GetPrintDataPathWithProperties
指定プリンタープロパティとコメントで作成した印刷データを生成し、ダウンロードのためのPATH(URL)を取得する GetPrintDataPathWithPropertiesAndComments
文書をコピーする CopyDocuments
ページ範囲を指定して文書をコピーする CopyDocumentsWithPageRange
印刷済みにしないプレビュー用データを取得する GetViewDataPerDoc
プリンタープロパティを指定して印刷済みにしないプレビュー用データを取得する GetViewDataWithPropertiesPerDoc
プリンタープロパティを指定して印刷済みにしないプレビュー用データとコメントを取得する GetViewDataWithPropertiesAndCommentsPerDoc
印刷済みにしないプレビュー用データのダウンロードPATH(URL)を取得する GetViewDataPathPerDoc
プリンタープロパティを指定して印刷済みにしないプレビュー用データのダウンロードPATH(URL)を取得する GetViewDataPathWithPropertiesPerDoc
プリンタープロパティを指定して印刷済みにしないプレビュー用データのダウンロードPATH(URL)とコメントを取得する GetViewDataPathWithPropertiesAndCommentsPerDoc

文書情報を取得する

メソッド名 Document GetDocument( p1 )
戻り値 文書情報(Document)
詳細は「3-5-5 文書クラス(document)プロパティ」を参照してください。
パラメーター
  • p1
    int docNum(文書管理番号)
例外
  • RdConnectException
    情報取得に失敗した場合
使用例
//文書情報を取得する
int docNum = 123; //文書管理番号123
ServiceRef.UdkConnect.document doc = UdkConnect.GetDocument( docNum );
Console.WriteLine( doc.docName ); //文書名を表示する

文書情報を取得する

メソッド名 Document[] GetDocuments( p1 )
戻り値 文書情報(Document)の配列
詳細は「3-5-5 文書クラス(document)プロパティ」を参照してください。
パラメーター
例外
  • RdConnectException
    情報取得に失敗した場合
使用例
//検索条件を作成する
ServiceRef.UdkConnect.documentFilter filter = new ServiceRef.UdkConnect.documentFilter();
filter.subdivision = 1; // 未印刷文書
//文書情報を取得する
ServiceRef.UdkConnect.document[] docs = UdkConnect.GetDocuments( filter );
for( int i=0; i < docs.Length; i++ ) {
  Console.WriteLine( docs[i].docName ); //文書名を表示する
}

文書情報を取得する

メソッド名 Document[] GetDocumentsWithIndexes( p1, p2 )
戻り値 文書情報(Document)の配列
詳細は「3-5-5 文書クラス(document)プロパティ」を参照してください。
パラメーター
例外
  • RdConnectException
    情報取得に失敗した場合
使用例
// 検索条件を作成する
ServiceRef.UdkConnect.documentFilter filter = new ServiceRef.UdkConnect.documentFilter();
filter.subdivision = 1; // 未印刷文書
//集合化する項目番号
int?[] indexes = { 0, 1, 2 }; // 0:文書名、1:コンピューター名、2:ユーザー名
// 文書情報を取得する
ServiceRef.UdkConnect.document[] docs = UdkConnect.GetDocumentsWithIndexes( filter, indexes );
for( int i=0; i < docs.Length; i++ ) {
  Console.WriteLine( docs[i].docName ); //文書名を表示する
}
注意
  • indexesで指定された文書項目番号の文書情報が同じ値を持つ場合、それらは1つに集合化されます。取得できる文書情報は、指定した文書項目番号の情報のみです。
  • 返される文書情報オブジェクトは変更できません。返される文書情報オブジェクトは、getDocuments()メソッド呼び出し時のスナップショットです。
    つまり、RdServer上の文書情報の内容が変更されても、返される文書情報オブジェクトの内容は更新されません。文書情報の変更を検出するには、個々の文書情報に対してgetDocument()を呼び出し、新規文書情報を以前の文書情報と比較します。

指定範囲の文書情報の一覧を取得する

メソッド名 PartOfDocuments GetDocumentsWithRange( p1, p2, p3 )
戻り値 範囲指定文書取得結果(partOfDocuments)
詳細は、「3-5-12 範囲指定文書取得結果クラス(partOfDocuments)プロパティ」を参照してください。
パラメーター
例外
  • RdConnectException
    情報取得に失敗した場合
使用例
// 検索条件を作成する
ServiceRef.UdkConnect.documentFilter filter = new ServiceRef.UdkConnect.documentFilter();
filter.subdivision = 1; // 未印刷文書

// 文書情報を取得する(先頭から50件まで取得する)
ServiceRef.UdkConnect.partOfDocuments pod = udkConnect.GetDocumentsWithRange(filter, 0, 50);
for (int i = 0; i < pod.documents.Length; i++)
{
  Console.WriteLine(pod.documents[i].docName); // 文書名を表示する
}

文書数を取得する

メソッド名 int GetDocumentCount( p1 )
戻り値 文書件数(int)
パラメーター
例外
  • RdConnectException
    情報取得に失敗した場合
使用例
// 検索条件を作成する
ServiceRef.UdkConnect.documentFilter filter = new ServiceRef.UdkConnect.documentFilter();
filter.subdivision = 1; // 未印刷文書

// 文書数を取得する
int docCount = udkConnect.GetDocumentCount(filter);

文書管理番号を取得する

メソッド名 int[] GetDocNums( p1 )
戻り値 文書管理番号(int)の配列
パラメーター
例外
  • RdConnectException
    情報取得に失敗した場合
使用例
//検索条件を作成する
ServiceRef.UdkConnect.documentFilter filter = new ServiceRef.UdkConnect.documentFilter();
filter.subdivision = 1; // 未印刷文書
//文書管理番号一覧を取得する
int[] docNums = UdkConnect. GetDocNums( filter );
for( int i=0; i < docNums.Length; i++ ) {
  Console.WriteLine( docNums[i] );
}

指定範囲の文書管理番号を取得する

メソッド名 PartOfDocNums GetDocNumsWithRange( p1, p2, p3 )
戻り値 範囲指定文書管理番号取得結果(partOfDocNums)
詳細は、「3-5-13 範囲指定文書管理番号取得結果クラス(partOfDocNums)プロパティ」を参照してください。
パラメーター
例外
  • RdConnectException
    情報取得に失敗した場合
使用例
// 検索条件を作成する
ServiceRef.UdkConnect.documentFilter filter = new ServiceRef.UdkConnect.documentFilter();
filter.subdivision = 1; // 未印刷文書

// 文書管理番号一覧を取得する(先頭から50件まで取得する)
ServiceRef.UdkConnect.partOfDocNums partOfDocNums = udkConnect.GetDocNumsWithRange(filter, 0, 50);
for (int i = 0; i < partOfDocNums.docNums.Length; i++)
{
  Console.WriteLine(partOfDocNums.docNums[i]);
}

印刷を実行する

メソッド名 void PrintToServerPrinter( p1, p2, p3 )
パラメーター
  • p1
    ServerPrinter printer(サーバープリンター情報)
  • p2
    int docNum(文書管理番号)
  • p3
    PrintAttributes pas(印刷属性)
例外
  • RdConnectException
    印刷に失敗した場合
使用例
// サーバープリンター情報を取得する
String printerName = "TestPrinter";
ServiceRef.UdkConnect.serverPrinter printer = UdkConnect.GetServerPrinter(printerName);
int docNum = 123;	// 文書管理番号123
// 印刷属性を作成する
ServiceRef.UdkConnect.printAttributes pas = new ServiceRef.UdkConnect.printAttributes();
pas.copyCount = 2;	// 2部印刷
pas.copyType = true;	// 部単位印刷
pas.pageRange = "*";	// すべて印刷
pas.tray = 1;		// 給紙トレイの選択
pas.paperType = -1; 	// 紙種(-1:指定なし)
pas.outputBin = 2;	// 排紙ビンの選択
// 印刷を実行する
UdkConnect.PrintToServerPrinter( printer, docNum, pas ); 

コメントを指定して印刷を実行する

メソッド名 void PrintToServerPrinterWithComments( p1, p2, p3, p4 )
パラメーター
  • p1
    ServerPrinter printer(サーバープリンター情報)
  • p2
    int docNum(文書管理番号)
  • p3
    PrintAttributes pas(印刷属性)
  • p4
    String[] comments(コメント)
例外
  • RdConnectException
    印刷に失敗した場合
使用例
// サーバープリンター情報を取得する
String printerName = "TestPrinter";
ServiceRef.UdkConnect.serverPrinter printer = UdkConnect.GetServerPrinter(printerName);
int docNum = 123; 	// 文書管理番号123
// 印刷属性を作成する
ServiceRef.UdkConnect.printAttributes pas = new ServiceRef.UdkConnect.printAttributes();
pas.copyCount = 2;	// 2部印刷
pas.copyType = true;	// 部単位印刷
pas.pageRange = "*"; 	// すべて印刷
pas.tray = 1; 		// 給紙トレイの選択
pas.paperType = -1;  	// 紙種(-1:指定なし)
pas.outputBin = 2;  	// 排紙ビンの選択
// コメントを作成する
String[] comments = { "comment1", "comment2"};
// 印刷を実行する
UdkConnect.PrintToServerPrinterWithComments( printer, docNum, pas, comments );
注意
コメントを指定して印刷する場合、コメントの出力先としてrd_comment0~rd_comment9までの予約フィールドを作成した様式ファイルを用意する必要があります。

複数文書の印刷を実行する

メソッド名 void PrintsToServerPrinter( p1, p2, p3 )
パラメーター
  • p1
    ServerPrinter printer(サーバープリンター情報)
  • p2
    int[] docNums(文書管理番号の配列)
  • p3
    PrintAttributes pas(印刷属性)
例外
  • RdConnectException
    印刷に失敗した場合
使用例
// サーバープリンター情報を取得する
String printerName = "TestPrinter";
ServiceRef.UdkConnect.serverPrinter printer = UdkConnect.GetServerPrinter(printerName);
int?[] docNums = { 123, 456 }; // 文書管理番号123,456
// 印刷属性を作成する
ServiceRef.UdkConnect.printAttributes pas = new ServiceRef.UdkConnect.printAttributes();
pas.copyCount = 2; 	// 2部印刷
pas.copyType = true; 	// 部単位印刷
pas.pageRange = "*"; 	// すべて印刷
pas.tray = 1;   	// 給紙トレイの選択
pas.paperType = -1;  	// 紙種(-1:指定なし)
pas.outputBin = 2; 	// 排紙ビンの選択
// 印刷を実行する
UdkConnect.PrintsToServerPrinter( printer, docNums, pas );

コメントを指定して複数文書の印刷を実行する

メソッド名 void PrintsToServerPrinterWithComments( p1, p2, p3, p4 )
パラメーター
  • p1
    ServerPrinter printer(サーバープリンター情報)
  • p2
    int[] docNums(文書管理番号の配列)
  • p3
    PrintAttributes pas(印刷属性)
  • p4
    String[] comments(コメント)
例外
  • RdConnectException
    印刷に失敗した場合
使用例
// サーバープリンター情報を取得する
String printerName = "TestPrinter";
ServiceRef.UdkConnect.serverPrinter printer = UdkConnect.GetServerPrinter(printerName);
int?[] docNums = { 123, 456 }; // 文書管理番号123,456
// 印刷属性を作成する
ServiceRef.UdkConnect.printAttributes pas = new ServiceRef.UdkConnect.printAttributes();
pas.copyCount = 2;	// 2部印刷
pas.copyType = true;	// 部単位印刷
pas.pageRange = "*";	// すべて印刷
pas.tray = 1;		// 給紙トレイの選択
pas.paperType = -1; 	// 紙種(-1:指定なし)
pas.outputBin = 2;	// 排紙ビンの選択
// コメントを作成する
String[] comments = { "comment1", "comment2"};
// 印刷を実行する
UdkConnect.PrintsToServerPrinterWithComments( printer, docNums, pas, comments); 

テスト印刷を実行する

メソッド名 void TestPrintToServerPrinter( p1, p2, p3 )
パラメーター
  • p1
    ServerPrinter printer(サーバープリンター情報)
  • p2
    int docNum(文書管理番号)
  • p3
    PrintAttributes pas(印刷属性)
例外
  • RdConnectException
    印刷に失敗した場合
使用例
// サーバープリンター情報を取得する
String printerName = "TestPrinter";
ServiceRef.UdkConnect.serverPrinter printer = UdkConnect.GetServerPrinter(printerName);
int docNum = 123;	// 文書管理番号123
// 印刷属性を作成する
ServiceRef.UdkConnect.printAttributes pas = new ServiceRef.UdkConnect.printAttributes();
pas.copyCount = 2;	// 2部印刷
pas.copyType = true;	// 部単位印刷
pas.pageRange = "*";	// すべて印刷
pas.tray = 1;		// 給紙トレイの選択
pas.paperType = -1; 	// 紙種(-1:指定なし)
pas.outputBin = 2;	// 排紙ビンの選択
// 印刷を実行する
UdkConnect.TestPrintToServerPrinter( printer, docNum, pas ); 

コメントを指定してテスト印刷を実行する

メソッド名 void TestPrintToServerPrinterWithComments( p1, p2, p3, p4 )
パラメーター
  • p1
    ServerPrinter printer(サーバープリンター情報)
  • p2
    int docNum(文書管理番号)
  • p3
    PrintAttributes pas(印刷属性)
  • p4
    String[] comments(コメント)
例外
  • RdConnectException
    印刷に失敗した場合
使用例
// サーバープリンター情報を取得する
String printerName = "TestPrinter";
ServiceRef.UdkConnect.serverPrinter printer = UdkConnect.GetServerPrinter(printerName);
int docNum = 123;	// 文書管理番号123
// 印刷属性を作成する
ServiceRef.UdkConnect.printAttributes pas = new ServiceRef.UdkConnect.printAttributes();
pas.copyCount = 2;	// 2部印刷
pas.copyType = true;	// 部単位印刷
pas.pageRange = "*";	// すべて印刷
pas.tray = 1;		// 給紙トレイの選択
pas.paperType = -1; 	// 紙種(-1:指定なし)
pas.outputBin = 2;	// 排紙ビンの選択
// コメントを作成する
String[] comments = { "comment1", "comment2"};
// 印刷を実行する
UdkConnect.TestPrintToServerPrinterWithComments( printer, docNum, pas , comments); 
注意
コメントを指定して印刷する場合、コメントの出力先としてrd_comment0~rd_comment9までの予約フィールドを作成した様式ファイルを用意する必要があります。

複数文書のテスト印刷を実行する

メソッド名 void TestPrintsToServerPrinter( p1, p2, p3 )
パラメーター
  • p1
    ServerPrinter printer(サーバープリンター情報)
  • p2
    int[] docNums(文書管理番号の配列)
  • p3
    PrintAttributes pas(印刷属性)
例外
  • RdConnectException
    印刷に失敗した場合
使用例
// サーバープリンター情報を取得する
String printerName = "TestPrinter";
ServiceRef.UdkConnect.serverPrinter printer = UdkConnect.GetServerPrinter(printerName);
int?[] docNums = { 123, 456 };	// 文書管理番号123
// 印刷属性を作成する
ServiceRef.UdkConnect.printAttributes pas = new ServiceRef.UdkConnect.printAttributes();
pas.copyCount = 2;	// 2部印刷
pas.copyType = true;	// 部単位印刷
pas.pageRange = "*";	// すべて印刷
pas.tray = 1;		// 給紙トレイの選択
pas.paperType = -1; 	// 紙種(-1:指定なし)
pas.outputBin = 2;	// 排紙ビンの選択
// 印刷を実行する
UdkConnect.TestPrintsToServerPrinterWithComments( printer, docNums, pas); 

コメントを指定して複数文書のテスト印刷を実行する

メソッド名 void TestPrintsToServerPrinterWithComments( p1, p2, p3, p4 )
パラメーター
  • p1
    ServerPrinter printer(サーバープリンター情報)
  • p2
    int[] docNums(文書管理番号の配列)
  • p3
    PrintAttributes pas(印刷属性)
  • p4
    String[] comments(コメント)
例外
  • RdConnectException
    印刷に失敗した場合
使用例
// サーバープリンター情報を取得する
String printerName = "TestPrinter";
ServiceRef.UdkConnect.serverPrinter printer = UdkConnect.GetServerPrinter(printerName);
int?[] docNums = { 123, 456 };	// 文書管理番号123
// 印刷属性を作成する
ServiceRef.UdkConnect.printAttributes pas = new ServiceRef.UdkConnect.printAttributes();
pas.copyCount = 2;	// 2部印刷
pas.copyType = true;	// 部単位印刷
pas.pageRange = "*";	// すべて印刷
pas.tray = 1;		// 給紙トレイの選択
pas.paperType = -1; 	// 紙種(-1:指定なし)
pas.outputBin = 2;	// 排紙ビンの選択
// コメントを作成する
String[] comments = { "comment1", "comment2"};
// 印刷を実行する
UdkConnect.TestPrintsToServerPrinterWithComments( printer, docNums, pas, comments); 

プリンターグループへ印刷を実行する

メソッド名 PrintResult[] PrintsToPrinterGroup( p1, p2, p3 )
戻り値 印刷結果(PrintResult)の配列
パラメーター
  • p1
    PrinterGroup group(プリンターグループ情報)
  • p2
    int[] docNums(文書管理番号の配列)
  • p3
    PrintAttributes pas(印刷属性)
例外
  • RdConnectException
    印刷に失敗した場合
使用例
// サーバープリンター情報を取得する
String groupName = "TestPrinterGroup";
ServiceRef.UdkConnect.printerGroup group = UdkConnect.GetPrinterGroup(groupName);
int?[] docNums = { 123, 456 }; // 文書管理番号123,456
// 印刷属性を作成する
ServiceRef.UdkConnect.printAttributes pas =     new ServiceRef.UdkConnect.printAttributes();
pas.copyCount = 2;	// 2部印刷
pas.copyType = true; 	// 部単位印刷
pas.pageRange = "*";	// すべて印刷
pas.tray = 1;           // 給紙トレイの選択
pas.paperType = -1; 	// 紙種(-1:指定なし)
pas.outputBin = 2;	// 排紙ビンの選択
// 印刷を実行する
ServiceRef.UdkConnect.printResult[] result = UdkConnect.PrintsToPrinterGroup( group, docNums, pas );

印刷を停止する

メソッド名 void StopDocument( p1 )
パラメーター
  • p1
    int docNum(文書管理番号)
例外
  • RdConnectException
    印刷停止に失敗した場合
使用例
// 印刷を停止する
int docNum = 123; //文書管理番号123
UdkConnect.StopDocument( docNum );

印刷を停止する

メソッド名 int[] StopDocuments( p1 )
戻り値 各文書に対する実行結果(int)の配列
パラメーター
  • p1
    int[] docNums(文書管理番号の配列)
例外
  • RdConnectException
    印刷停止に失敗した場合
使用例
// 印刷を停止する
int?[] docNums = { 123, 456 }; //文書管理番号123,456
UdkConnect.StopDocuments( docNums );

印刷を中断する

メソッド名 void AbortDocument( p1 )
パラメーター
  • p1
    int docNum(文書管理番号)
例外
  • RdConnectException
    印刷中断に失敗した場合
使用例
// 印刷を中断する
int docNum = 123; //文書管理番号123
UdkConnect.AbortDocument( docNum );

印刷を中断する

メソッド名 int[] AbortDocuments( p1 )
戻り値 各文書に対する実行結果(int)の配列
パラメーター
  • p1
    int[] docNums(文書管理番号の配列)
例外
  • RdConnectException
    印刷中断に失敗した場合
使用例
// 印刷を中断する
int?[] docNums = { 123, 456 }; //文書管理番号123,456
UdkConnect.AbortDocuments( docNums );

印刷を再開する

メソッド名 void RestartDocument( p1 )
パラメーター
  • p1
    int docNum(文書管理番号)
例外
  • RdConnectException
    印刷再開に失敗した場合
使用例
// 印刷を再開する
int docNum = 123; //文書管理番号123
UdkConnect.RestartDocument( docNum );

印刷を再開する

メソッド名 int[] RestartDocuments( p1 )
戻り値 各文書に対する実行結果(int)の配列
パラメーター
  • p1
    int[] docNums(文書管理番号の配列)
例外
  • RdConnectException
    印刷再開に失敗した場合
使用例
// 印刷を再開する
int?[] docNums = { 123, 456 }; //文書管理番号123,456
UdkConnect.RestartDocuments( docNums );

文書を削除する

メソッド名 void DeleteDocument( p1 )
パラメーター
  • p1
    int docNum(文書管理番号)
例外
  • RdConnectException
    文書の削除に失敗した場合
使用例
// 印刷を削除する
int docNum = 123; //文書管理番号123
UdkConnect.DeleteDocument( docNum );

プリンターキュー文書情報一覧を取得する

メソッド名 QueueDocument[] GetPrinterQueueDocuments( p1 )
戻り値 プリンターキュー情報(QueueDocument)の配列
詳細は「3-5-6 プリンターキュー文書クラス(queueDocument)プロパティ」を参照してください。
パラメーター
  • p1
    String printerName(プリンター名)
例外
  • RdConnectException
    情報取得に失敗した場合
使用例
//プリンターキューの文書情報一覧を取得する
String printerName = "TestPrinter";
ServiceRef.UdkConnect.queueDocument[] docs =  UdkConnect.GetPrinterQueueDocuments(printerName);
for( int i=0; i < docs.Length; i++ )
{
  Console.WriteLine( docs[i].docName ); //文書名を表示する
}

プリンターキュー文書の優先順位を変更する

メソッド名 void UpdatePrinterQueueDocument( p1, p2 )
パラメーター
  • p1
    QueueDocument doc(プリンターキュー文書情報)
  • p2
    int updateKind(優先順位)
    • 0
      UP
    • 1
      DOWN
例外
  • RdConnectException
    情報更新に失敗した場合
使用例
// プリンターキューの文書情報一覧を取得する
String printerName = "TestPrinter";
ServiceRef.UdkConnect.queueDocument[] docs =  UdkConnect.GetPrinterQueueDocuments(printerName);
if( docs != null && docs.Length > 0 )
{
  // 先頭文書の優先順位を下げる
  UdkConnect.UpdatePrinterQueueDocument( docs[0], 1 );
}

プリンターキューの優先順位を変更する

メソッド名 void UpdatePrinterQueueDocuments( p1, p2 )
パラメーター
  • p1
    QueueDocument[] docs(プリンターキュー文書情報の一覧)
  • p2
    int updateKind(優先順位)
    • 0
      UP
    • 1
      DOWN
例外
  • RdConnectException
    更新に失敗した場合
使用例
// プリンターキューの文書情報一覧を取得する
String printerName = "TestPrinter";
ServiceRef.UdkConnect.queueDocument[] docs =  UdkConnect.GetPrinterQueueDocuments(printerName);
// 全文書の優先順位を上げる
UdkConnect.UpdatePrinterQueueDocuments( docs, 0 );

停止文書の印刷先を変更する

メソッド名 void ChangePrinter( p1, p2, p3 )
パラメーター
  • p1
    ServerPrinter oldPrinter(変更元プリンター情報)
  • p2
    ServerPrinter newPrinter(変更先プリンター情報)
  • p3
    int docNum(文書管理番号)
例外
  • RdConnectException
    ログインに失敗した場合
使用例
// プリンター情報を取得する
String printerName1 = "TestPrinter1";
String printerName2 = "TestPrinter2";
ServiceRef.UdkConnect.serverPrinter oldPrinter =  udkConnect.GetServerPrinter(printerName1)
ServiceRef.UdkConnect.serverPrinter newPrinter =  udkConnect.GetServerPrinter(printerName2)
int docNum = 123; //文書管理番号123
// 印刷先を変更する
UdkConnect.ChangePrinter( oldPrinter, newPrinter, docNum );

印刷データを取得する

メソッド名 Byte[] GetPrintData( p1, p2, p3 )
戻り値 作成された印刷用データ(Byte[])
パラメーター
  • p1
    String printerKind(プリンター機種名)
  • p2
    int docNum(文書管理番号)
  • p3
    PrintAttributes pas(印刷属性)
例外
  • RdConnectException
    印刷データ取得に失敗した場合
使用例
String printerKind = "PDF"; // プリンター機種名=PDF
int docNum = 123; // 文書管理番号123
// 印刷属性を作成する
ServiceRef.UdkConnect.printAttributes pas = new ServiceRef.UdkConnect.printAttributes();
pas.copyCount = 1;	// 1部印刷
pas.copyType = true;	// 部単位印刷
pas.pageRange = "*";	// すべて印刷
pas.tray = -1;		// 給紙トレイの選択
pas.outputBin = -1;	// 排紙ビンの選択
// 印刷を実行する
Byte[] data = UdkConnect.GetPrintData(printerKind, docNum, pas );
参考

容量の大きい帳票データを取得する場合、本メソッドの使用は推奨しません。「GetPrintDataPath」メソッドの使用を推奨します。

プリンタープロパティを指定して印刷データを取得する

メソッド名 Byte[] GetPrintDataWithProperties( p1, p2, p3 )
戻り値 作成された印刷用データ(Byte[])
パラメーター
  • p1
    nameAndvalue [] props(プリンター機種のプロパティ)
  • p2
    int docNum(文書管理番号)
  • p3
    PrintAttributes pas(印刷属性)
例外
  • RdConnectException
    ログインに失敗した場合
使用例
String printerKind = "PDF"; // プリンター機種名=PDF
ServiceRef.UdkConnect.nameAndValue[] props =  UdkConnect.GetPrinterKindProperties(printerKind);
int docNum = 123; //文書管理番号123
// 印刷属性を作成する
ServiceRef.UdkConnect.printAttributes pas = new ServiceRef.UdkConnect.printAttributes();
pas.copyCount = 1;	// 1部印刷
pas.copyType = true;	// 部単位印刷
pas.pageRange = "*";	// すべて印刷
pas.tray = -1;		// 給紙トレイの選択
pas.outputBin = -1;	// 排紙ビンの選択
// 印刷データを取得する
Byte[] data = UdkConnect.GetPrintDataWithProperties(props, docNum, pas );
参考

容量の大きい帳票データを取得する場合、本メソッドの使用は推奨しません。「GetPrintDataPathWithProperties」メソッドの使用を推奨します。

プリンタープロパティとコメントを指定して印刷データを取得する

メソッド名 Byte[] GetPrintDataWithPropertiesAndComments( p1, p2, p3, p4 )
戻り値 作成された印刷用データ(Byte[])
パラメーター
  • p1
    nameAndValue [] props(プリンター機種のプロパティ)
  • p2
    int docNum(文書管理番号)
  • p3
    PrintAttributes pas(印刷属性)
  • p4
    String[] comments(コメント)
例外
  • RdConnectException
    ログインに失敗した場合
使用例
String printerKind = "PDF"; // プリンター機種名=PDF
ServiceRef.UdkConnect.nameAndValue[] props =  UdkConnect.GetPrinterKindProperties(printerKind);
int docNum = 123; //文書管理番号123
// 印刷属性を作成する
ServiceRef.UdkConnect.printAttributes pas = new ServiceRef.UdkConnect.printAttributes();
pas.copyCount = 1;	// 1部印刷
pas.copyType = true;	// 部単位印刷
pas.pageRange = "*";	// すべて印刷
pas.tray = -1;		// 給紙トレイの選択
pas.outputBin = -1;	// 排紙ビンの選択
// rd_comment[0-9]のフィールドにコメントを設定
String[] comments = new String[10];
comments[0] = "コメント";
// 印刷データを取得する
Byte[] data = UdkConnect.GetPrintDataWithPropertiesAndComments(props, docNum, pas, comments);
参考

容量の大きい帳票データを取得する場合、本メソッドの使用は推奨しません。「GetPrintDataPathWithPropertiesAndComments」メソッドの使用を推奨します。

印刷データを生成し、ダウンロードするためのPATH(URL)を取得する

メソッド名 String GetPrintDataPath( p1, p2, p3 )
戻り値 作成された印刷用データを取得(ダウンロード)するためのURLパス(String)
パラメーター
  • p1
    String printerKind(プリンター機種名)
  • p2
    int docNum(文書管理番号)
  • p3
    PrintAttributes pas(印刷属性)
例外
  • RdConnectException
    ログインに失敗した場合
使用例
String printerKind = "PDF"; // プリンター機種名=PDF
int docNum = 123; //文書管理番号123
// 印刷属性を作成する
ServiceRef.UdkConnect.printAttributes pas = new ServiceRef.UdkConnect.printAttributes();
pas.copyCount = 1;	// 1部印刷
pas.copyType = true;	// 部単位印刷
pas.pageRange = "*";	// すべて印刷
pas.tray = -1;		// 給紙トレイの選択
pas.outputBin = -1;	// 排紙ビンの選択
// 印刷データを作成する
String path = UdkConnect.GetPrintDataPath( printerKind, docNum, pas );

指定プリンタープロパティで作成した印刷データを生成し、ダウンロードのためのPATH(URL)を取得する

メソッド名 String GetPrintDataPathWithProperties( p1, p2, p3 )
戻り値 作成された印刷用データを取得(ダウンロード)するためのURLパス(String)
パラメーター
  • p1
    nameAndValue [] props(プリンター機種のプロパティ)
  • p2
    int docNum(文書管理番号)
  • p3
    PrintAttributes pas(印刷属性)
例外
  • RdConnectException
    ログインに失敗した場合
使用例
String printerKind = "PDF"; // プリンター機種名=PDF
ServiceRef.UdkConnect.nameAndValue[] props =  UdkConnect.GetPrinterKindProperties(printerKind);
int docNum = 123;             //文書管理番号123
// 印刷属性を作成する
ServiceRef.UdkConnect.printAttributes pas = new ServiceRef.UdkConnect.printAttributes();
pas.copyCount = 1;	// 1部印刷
pas.copyType = true;	// 部単位印刷
pas.pageRange = "*";	// すべて印刷
pas.tray = -1;		// 給紙トレイの選択
pas.outputBin = -1;	// 排紙ビンの選択
// 印刷データを作成する
String path = UdkConnect.GetPrintDataPathWithProperties(props, docNum, pas );

指定プリンタープロパティとコメントで作成した印刷データを生成し、ダウンロードのためのPATH(URL)を取得する

メソッド名 String GetPrintDataPathWithPropertiesAndComments( p1, p2, p3, p4 )
戻り値 作成された印刷用データを取得(ダウンロード)するためのURLパス(String)
パラメーター
  • p1
    NameAndValue[] props(プリンター機種のプロパティ)
  • p2
    int docNum(文書管理番号)
  • p3
    PrintAttributes pas(印刷属性)
  • p4
    String[] comments(コメント)
例外
  • RdConnectException
    ログインに失敗した場合
使用例
String printerKind = "PDF"; // プリンター機種名=PDF
ServiceRef.UdkConnect.nameAndValue[] props =  UdkConnect.GetPrinterKindProperties(printerKind);
int docNum = 123; // 文書管理番号=123
// 印刷属性を作成する
ServiceRef.UdkConnect.printAttributes pas = new ServiceRef.UdkConnect.printAttributes();
pas.copyCount = 1;	// 1部印刷
pas.copyType = true;	// 部単位印刷
pas.pageRange = "*";	// すべて印刷
pas.tray = -1;		// 給紙トレイの選択
pas.outputBin = -1;	// 排紙ビンの選択
// rd_comment[0-9]のフィールドにコメントを設定
String[] comments = new String[10];
comments[0] = "コメント";
// 印刷データを取得する
String path = UdkConnect.GetPrintDataPathWithPropertiesAndComments(props, docNum, pas, comments);

文書をコピーする

メソッド名 CopyDocumentOpResult[] CopyDocuments( p1 )
戻り値 各文書のコピー結果(CopyDocumentOpResult)の配列
詳細は、「3-5-11 コピー結果クラス(CopyDocumentOpResult)プロパティ」を参照してください。
戻り値 コピー結果(CopyDocumentOpResult)の配列
パラメーター
  • p1
    int[] docNums(文書管理番号の配列)
例外
  • RdConnectException
    コピーに失敗した場合
使用例
// 文書をコピーする
int?[] docNums = { 123, 456 };          //文書管理番号123,456
ServiceRef.UdkConnect.CopyDocumentOpResult[] copy = UdkConnect.CopyDocuments( docNums );

ページ範囲を指定して文書をコピーする

メソッド名 CopyDocumentOpResult[] CopyDocumentsWithPageRange( p1, p2 )
戻り値 コピー結果(CopyDocumentOpResult)の配列
詳細は「3-5-11 コピー結果クラス(CopyDocumentOpResult)プロパティ」を参照してください。
パラメーター
  • p1
    int[] docNums(文書管理番号の配列)
  • p2
    String pageRange(ページ指定)
    「1,3,6」のようにページ番号をカンマで区切って指定するか、「4-8」のようにページ範囲を指定します。すべてのページは「*」、未印刷ページすべては「null」を指定します。
例外
  • RdConnectException
    コピーに失敗した場合
使用例
// ページ範囲を指定して文書をコピーする
int?[] docNums = { 123, 456 };          // 文書管理番号123,456
ServiceRef.UdkConnect.copyDocumentOpResult[] copy = UdkConnect.CopyDocumentsWithPageRange( docNums, "4-8" );

印刷済みにしないプレビュー用データを取得する

メソッド名 Byte[] GetViewDataPerDoc( p1, p2, p3 )
戻り値 印刷済みにしないプレビュー用データ(Byte[])
パラメーター
  • p1
    String printerKind(プリンター機種名)
  • p2
    int docNum(文書管理番号)
  • p3
    printAttributes (印刷属性)
例外
  • RdConnectException
    情報取得に失敗した場合
使用例
String printerKind = "EMF";
int docNum = 123; //文書管理番号123

// 印刷属性を作成する
ServiceRef.UdkConnect.printAttributes pas = new ServiceRef.UdkConnect.printAttributes();
pas.copyCount = 1;   // 1部印刷
pas.copyType = true;  // 部単位印刷
pas.pageRange = "1"; // 1ページ目

// ビューデータを生成する
Byte[] data = udkConnect.GetViewDataPerDoc(printerKind, docNum, pas);

プリンタープロパティを指定して印刷済みにしないプレビュー用データを取得する

メソッド名 Byte[] GetViewDataWithPropertiesPerDoc( p1, p2, p3 )
戻り値 印刷済みにしないプレビュー用データ(Byte[])
パラメーター
  • p1
    nameAndvalue [] printerKindProperties(プリンター機種のプロパティ)
  • p2
    int docNum(文書管理番号)
  • p3
    printAttributes(印刷属性)
例外
  • RdConnectException
    情報取得に失敗した場合
使用例
// プリンター機種のデフォルトプロパティを取得する
String printerKind = "EMF";
ServiceRef.UdkConnect.nameAndValue[] props = udkConnect.GetPrinterKindProperties(printerKind);
for (int i = 0; i < props.Length; i++)
{
  if (props[i].name.Equals("Spool.Method"))
  {
    props[i].value = "3"; //作成したデータを圧縮する
    break;
  }
}

int docNum = 123; //文書管理番号123

// 印刷属性を作成する
ServiceRef.UdkConnect.printAttributes pas = new ServiceRef.UdkConnect.printAttributes();
pas.copyCount = 1;   // 1部印刷
pas.copyType = true;  // 部単位印刷
pas.pageRange = "1"; // 1ページ目

// ビューデータを生成する
Byte[] data = udkConnect.GetViewDataWithPropertiesPerDoc(props, docNum, pas);

プリンタープロパティを指定して印刷済みにしないプレビュー用データとコメントを取得する

メソッド名 Byte[] GetViewDataWithPropertiesAndCommentsPerDoc( p1, p2, p3, p4 )
戻り値 印刷済みにしないプレビュー用データ(Byte[])
パラメーター
  • p1
    nameAndvalue [] printerKindProperties(プリンター機種のプロパティ)
  • p2
    int docNum(文書管理番号)
  • p3
    printAttributes(印刷属性)
  • p4
    comments(コメント)
例外
  • RdConnectException
    情報取得に失敗した場合
使用例
// プリンター機種のデフォルトプロパティを取得する
String printerKind = "EMF";
ServiceRef.UdkConnect.nameAndValue[] props = udkConnect.GetPrinterKindProperties(printerKind);
for (int i = 0; i < props.Length; i++)
{
  if (props[i].name.Equals("Spool.Method"))
  {
    props[i].value = "3"; //作成したデータを圧縮する
    break;
  }
}

int docNum = 123; //文書管理番号123

// 印刷属性を作成する
ServiceRef.UdkConnect.printAttributes pas = new ServiceRef.UdkConnect.printAttributes();
pas.copyCount = 1;   // 1部印刷
pas.copyType = true;  // 部単位印刷
pas.pageRange = "1"; // 1ページ目

// rd_comment[0-9]のフィールドにコメントを設定
String[] comments = new String[10];
comments[0] = "コメント";

// ビューデータを生成する
Byte[] data = udkConnect.GetViewDataWithPropertiesAndCommentsPerDoc(props, docNum, pas, comments);

印刷済みにしないプレビュー用データのダウンロードPATH(URL)を取得する

メソッド名 String GetViewDataPathPerDoc( p1, p2, p3 )
戻り値 印刷済みにしないプレビュー用データを取得(ダウンロード)するためのURLパス(String)
パラメーター
  • p1
    String printerKind(プリンター機種名)
  • p2
    int docNum(文書管理番号)
  • p3
    printAttributes(印刷属性)
例外
  • RdConnectException
    情報取得に失敗した場合
使用例
String printerKind = "EMF";
int docNum = 123; //文書管理番号123

// 印刷属性を作成する
ServiceRef.UdkConnect.printAttributes pas = new ServiceRef.UdkConnect.printAttributes();
pas.copyCount = 1;   // 1部印刷
pas.copyType = true;  // 部単位印刷
pas.pageRange = "1"; // 1ページ目

// ビューデータを生成する
String path = udkConnect.GetViewDataPathPerDoc(printerKind, docNum, pas);

プリンタープロパティを指定して印刷済みにしないプレビュー用データのダウンロードPATH(URL)を取得する

メソッド名 String GetViewDataPathWithPropertiesPerDoc( p1, p2, p3 )
戻り値 印刷済みにしないプレビュー用データを取得(ダウンロード)するためのURLパス(String)
パラメーター
  • p1
    nameAndvalue [] printerKindProperties(プリンター機種のプロパティ)
  • p2
    int docNum(文書管理番号)
  • p3
    printAttributes(印刷属性)
例外
  • RdConnectException
    情報取得に失敗した場合
使用例
// プリンター機種のデフォルトプロパティを取得する
String printerKind = "EMF";
ServiceRef.UdkConnect.nameAndValue[] props = udkConnect.GetPrinterKindProperties(printerKind);
for (int i = 0; i < props.Length; i++)
{
  if (props[i].name.Equals("Spool.Method"))
  {
    props[i].value = "3"; //作成したデータを圧縮する
    break;
  }
}

int docNum = 123; //文書管理番号123

// 印刷属性を作成する
ServiceRef.UdkConnect.printAttributes pas = new ServiceRef.UdkConnect.printAttributes();
pas.copyCount = 1;   // 1部印刷
pas.copyType = true;  // 部単位印刷
pas.pageRange = "1"; // 1ページ目

// ビューデータを生成する
String path = udkConnect.GetViewDataPathWithPropertiesPerDoc(props, docNum, pas);

 

プリンタープロパティを指定して印刷済みにしないプレビュー用データのダウンロードPATH(URL)とコメントを取得する

メソッド名 String GetViewDataPathWithPropertiesAndCommentsPerDoc( p1, p2, p3, p4 )
戻り値 印刷済みにしないプレビュー用データを取得(ダウンロード)するためのURLパス(String)
パラメーター
  • p1
    nameAndvalue [] printerKindProperties(プリンター機種のプロパティ)
  • p2
    int docNum(文書管理番号)
  • p3
    printAttributes(印刷属性)
  • p4
    comments(コメント)
例外
  • RdConnectException
    情報取得に失敗した場合
使用例
// プリンター機種のデフォルトプロパティを取得する
String printerKind = "EMF";
ServiceRef.UdkConnect.nameAndValue[] props = udkConnect.GetPrinterKindProperties(printerKind);
for (int i = 0; i < props.Length; i++)
{
  if (props[i].name.Equals("Spool.Method"))
  {
    props[i].value = "3"; //作成したデータを圧縮する
    break;
  }
}

int docNum = 123; //文書管理番号123

// 印刷属性を作成する
ServiceRef.UdkConnect.printAttributes pas = new ServiceRef.UdkConnect.printAttributes();
pas.copyCount = 1;   // 1部印刷
pas.copyType = true;  // 部単位印刷
pas.pageRange = "1"; // 1ページ目

// rd_comment[0-9]のフィールドにコメントを設定
String[] comments = new String[10];
comments[0] = "コメント";

// ビューデータを生成する
String path = udkConnect.GetViewDataPathWithPropertiesAndCommentsPerDoc(props, docNum, pas, comments);