スタイル - スコープ対象、グローバル

フォントサイズ、境界線、配置などのプロパティを定義するためのスタイルを作成します。同じスタイルを複数のオブジェクトに同時に適用できます。

この API は ServiceNow PDF 生成ユーティリティプラグイン (com.snc.apppdfgenerator) の一部であり、 sn_pdfgeneratorutils 名前空間内で提供されます。このプラグインはデフォルトでアクティブ化されています。

この API は、PDF を生成するために ドキュメント API で使用されるコンポーネントです。

カスタムスタイルは、次の API 要素に適用できます。

• セル
• パラグラフ
• テーブル

スタイル:style()

新しい スタイル オブジェクトをインスタンス化します。

表 : 1. パラメーター

名前	タイプ	説明
なし

次の例は、セル、段落、またはテーブル要素に追加できるスタイルオブジェクトを作成する方法を示しています。

var style = new sn_pdfgeneratorutils.Style();

スタイル – setBackgroundColor(色の色)

要素の背景色を指定します。

表 : 2. パラメーター

名前	タイプ	説明
色	色	背景色。

表 : 3. 戻り値

タイプ	説明
なし

次の例は、要素の背景色を設定する方法を示しています。 ドキュメントの使用例については、「 ドキュメント API」 を参照してください。

var style = new sn_pdfgeneratorutils.Style();

var color = new sn_pdfgeneratorutils.Color([1, 0.9, 0.9]); // provided as array of RGB float values

style.setBackGroundColor(color);

スタイル – setBold()

スタイルを太字フォントに設定します。

表 : 4. パラメーター

名前	タイプ	説明
なし

表 : 5. 戻り値

タイプ	説明
なし

次の例は、スタイルを太字フォントに設定する方法を示しています。

var style = new sn_pdfgeneratorutils.Style();
style.setBold();

スタイル – setBorder(数値幅)

要素の 4 つの辺すべてのスタイル境界線を設定します。

表 : 6. パラメーター

名前	タイプ	説明
幅	番号	境界線の幅をポイント単位でスタイルします。

表 : 7. 戻り値

タイプ	説明
なし

次の例は、スタイルの境界線を設定する方法を示しています。 ドキュメントの使用例については、「 ドキュメント API」 を参照してください。

var style = new sn_pdfgeneratorutils.Style();

var width = 2;

style.setBorder(width);

スタイル – setBorderBottom(数値幅)

スタイルの境界線を要素の下部に設定します。

表 : 8. パラメーター

名前	タイプ	説明
幅	番号	境界線の幅をポイント単位でスタイルします。

表 : 9. 戻り値

タイプ	説明
なし

次の例は、スタイルの境界線を要素の下部に設定する方法を示しています。 ドキュメントの使用例については、「 ドキュメント API」 を参照してください。

var style = new sn_pdfgeneratorutils.Style();

var width = 2;

style.setBorderBottom(width);

スタイル – setBorderLeft(数値幅)

要素の左側にスタイルの境界線を設定します。

表 : 10. パラメーター

名前	タイプ	説明
幅	番号	境界線の幅をポイント単位でスタイルします。

表 : 11. 戻り値

タイプ	説明
なし

次の例は、要素の左側にスタイルの境界線を設定する方法を示しています。 ドキュメントの使用例については、「 ドキュメント API」 を参照してください。

var style = new sn_pdfgeneratorutils.Style();

var width = 2;

style.setBorderLeft(width);

スタイル – setBorderRight(数値幅)

要素の右側にスタイルの境界線を設定します。

表 : 12. パラメーター

名前	タイプ	説明
幅	番号	境界線の幅をポイント単位でスタイルします。

表 : 13. 戻り値

タイプ	説明
なし

次の例は、要素の右側にスタイルの境界線を設定する方法を示しています。 ドキュメントの使用例については、「 ドキュメント API」 を参照してください。

var style = new sn_pdfgeneratorutils.Style();

var width = 2;

style.setBorderRight(width);

スタイル – setBorderTop(数値幅)

スタイルの境界線を要素の上部に設定します。

表 : 14. パラメーター

名前	タイプ	説明
幅	番号	境界線の幅をポイント単位でスタイルします。

表 : 15. 戻り値

タイプ	説明
なし

次の例は、スタイルの境界線を要素の上部に設定する方法を示しています。 ドキュメントの使用例については、「 ドキュメント API」 を参照してください。

var style = new sn_pdfgeneratorutils.Style();

var width = 2;

style.setBorderTop(width);

スタイル – setColoredBorder(数値幅、色の色)

要素の 4 つの辺すべてに色付きのスタイル境界線を設定します。

表 : 16. パラメーター

名前	タイプ	説明
幅	番号	境界線の幅をポイント単位でスタイルします。
色	色	境界色をスタイル設定します。

表 : 17. 戻り値

タイプ	説明
なし

次の例は、色付きのスタイル境界線を設定する方法を示しています。 ドキュメントの使用例については、「 ドキュメント API」 を参照してください。

var style = new sn_pdfgeneratorutils.Style();

var width = 1.0;
var borderColor = new sn_pdfgeneratorutils.Color([0.8,0.8,0.8]);

style.setColoredBorder(width, borderColor);

スタイル – setColoredBorderBottom(数値の幅, 色の色)

要素の下側に色付きのスタイル境界線を設定します。

表 : 18. パラメーター

名前	タイプ	説明
幅	番号	境界線の幅をポイント単位でスタイルします。
色	色	境界色をスタイル設定します。

表 : 19. 戻り値

タイプ	説明
なし

次の例は、スタイルの境界線を要素の下部に設定する方法を示しています。ドキュメントの使用例については、「 ドキュメント API」 を参照してください。

var style = new sn_pdfgeneratorutils.Style();

var width = 1.0;
var borderColor = new sn_pdfgeneratorutils.Color([0.8,0.8,0.8]);

style.setColoredBorderBottom(width, borderColor);

スタイル – setColoredBorderLeft(数値の幅, 色の色)

要素の左側に色付きのスタイル境界線を設定します。

表 : 20. パラメーター

名前	タイプ	説明
幅	番号	境界線の幅をポイント単位でスタイルします。
色	色	境界色をスタイル設定します。

表 : 21. 戻り値

タイプ	説明
なし

次の例は、スタイルの境界線を設定する方法を示しています。 ドキュメントの使用例については、「 ドキュメント API」 を参照してください。

var style = new sn_pdfgeneratorutils.Style();

var width = 1.0;
var borderColor = new sn_pdfgeneratorutils.Color([0.8,0.8,0.8]);

style.setColoredBorderLeft(width, borderColor);

スタイル – setColoredBorderRight(数値の幅, 色の色)

要素の右側に色付きのスタイル境界線を設定します。

表 : 22. パラメーター

名前	タイプ	説明
幅	番号	境界線の幅をポイント単位でスタイルします。
色	色	境界色をスタイル設定します。

表 : 23. 戻り値

タイプ	説明
なし

次の例は、色付きのスタイル境界線を設定する方法を示しています。 ドキュメントの使用例については、「 ドキュメント API」 を参照してください。

var style = new sn_pdfgeneratorutils.Style();

var width = 1.0;
var borderColor = new sn_pdfgeneratorutils.Color([0.8,0.8,0.8]);

style.setColoredBorderRight(width, borderColor);

スタイル – setColoredBorderTop(数値幅, 色の色)

要素の上側に色付きのスタイル境界線を設定します。

表 : 24. パラメーター

名前	タイプ	説明
幅	番号	境界線の幅をポイント単位でスタイルします。
色	色	境界色をスタイル設定します。

表 : 25. 戻り値

タイプ	説明
なし

次の例は、スタイルの境界線を設定する方法を示しています。 ドキュメントの使用例については、「 ドキュメント API」 を参照してください。

var style = new sn_pdfgeneratorutils.Style();

var width = 1.0;
var borderColor = new sn_pdfgeneratorutils.Color([0.8,0.8,0.8]);

style.setColoredBorderTop(width, borderColor);

スタイル – setFontColor(色の色)

フォントの色を設定します。

表 : 26. パラメーター

名前	タイプ	説明
色	色	フォントの色。

表 : 27. 戻り値

タイプ	説明
なし

次の例は、フォントの色を設定する方法を示しています。 ドキュメントの使用例については、「 ドキュメント API」 を参照してください。

var style = new sn_pdfgeneratorutils.Style();

var fontColor = new sn_pdfgeneratorutils.Color([1,0.5,0.5]);

style.setFontColor(fontColor);

スタイル – setFontSize(数値 fontSize)

スタイルのフォントサイズを設定します。

表 : 28. パラメーター

名前	タイプ	説明
フォントサイズ	番号	フォントサイズ (ポイント単位)。

表 : 29. 戻り値

タイプ	説明
なし

次の例は、フォントサイズを設定する方法を示しています。

var style = new sn_pdfgeneratorutils.Style();

style.setFontSize(12);

スタイル – setHorizontalAlignment(文字列の配置)

スタイルの水平配置を設定します。

表 : 30. パラメーター

名前	タイプ	説明
位置調整	文字列	水平配置の設定。 有効な値： 中央:コンテンツを中央に揃えます。 left:コンテンツを左揃えにします。 右:コンテンツを右揃えします。

表 : 31. 戻り値

タイプ	説明
なし

次の例は、要素の水平配置を設定する方法を示しています。 ドキュメントの使用例については、「 ドキュメント API」 を参照してください。

var style = new sn_pdfgeneratorutils.Style();

var alignment = "Center";

style.setHorizontalAlignment(alignment);

スタイル – setItalic()

スタイルを斜体フォントに設定します。

表 : 32. パラメーター

名前	タイプ	説明
なし

表 : 33. 戻り値

タイプ	説明
なし

次の例は、要素スタイルを斜体フォントに設定する方法を示しています。

var style = new sn_pdfgeneratorutils.Style();
style.setItalic();

スタイル – setPadding(数値のパディング)

要素の 4 つの辺すべてのパディングを同じ幅に設定します。

関連項目：

• setPaddingBottom()
• setPaddingLeft()
• setPaddingRight()
• setPaddingTop()

表 : 34. パラメーター

名前	タイプ	説明
padding	番号	パディング幅 (10 進数値としてのポイント単位)。

表 : 35. 戻り値

タイプ	説明
なし

次の例は、下のスタイルを 2.5 ポイントに設定する方法を示しています。 ドキュメントの使用例については、「 ドキュメント API」 を参照してください。

var style = new sn_pdfgeneratorutils.Style();

var padding = 2.5;

style.setPadding(padding);

スタイル – setPaddingBottom(数値のパディング)

要素の下部のパディング幅の値を設定します。

関連項目：

• setPadding()
• setPaddingLeft()
• setPaddingRight()
• setPaddingTop()

表 : 36. パラメーター

名前	タイプ	説明
padding	番号	パディング幅 (10 進数値としてのポイント単位)。

表 : 37. 戻り値

タイプ	説明
なし

次の例は、下部要素のパディングを 2.5 ポイントに設定する方法を示しています。 ドキュメントの使用例については、「 ドキュメント API」 を参照してください。

var style = new sn_pdfgeneratorutils.Style();

var padding = 2.5;

style.setPaddingBottom(padding);

スタイル – setPaddingLeft(数値のパディング)

要素の左側のパディング幅の値を設定します。

関連項目：

• setPadding()
• setPaddingBottom()
• setPaddingRight()
• setPaddingTop()

表 : 38. パラメーター

名前	タイプ	説明
padding	番号	パディング幅 (10 進数値としてのポイント単位)。

表 : 39. 戻り値

タイプ	説明
なし

次の例は、左側の要素のパディングを 2.5 ポイントに設定する方法を示しています。 ドキュメントの使用例については、「 ドキュメント API」 を参照してください。

var style = new sn_pdfgeneratorutils.Style();

var padding = 2.5;

style.setPaddingLeft(padding);

スタイル – setPaddingRight(数値のパディング)

スタイルの正しいパディング幅の値を設定します。

関連項目：

• setPadding()
• setPaddingBottom()
• setPaddingLeft()
• setPaddingTop()

表 : 40. パラメーター

名前	タイプ	説明
padding	番号	パディング幅 (10 進数値としてのポイント単位)。

表 : 41. 戻り値

タイプ	説明
なし

次の例は、右側の要素パディングを 2.5 ポイントに設定する方法を示しています。 ドキュメントの使用例については、「 ドキュメント API」 を参照してください。

var style = new sn_pdfgeneratorutils.Style();

var padding = 2.5;

style.setPaddingRight(padding);

スタイル – setPaddingTop(数値のパディング)

要素の上部パディング幅の値を設定します。

関連項目：

• setPadding()
• setPaddingBottom()
• setPaddingLeft()
• setPaddingRight()

表 : 42. パラメーター

名前	タイプ	説明
padding	番号	パディング幅 (10 進数値としてのポイント単位)。

表 : 43. 戻り値

タイプ	説明
なし

次の例は、上部要素のパディングを 2.5 ポイントに設定する方法を示しています。 ドキュメントの使用例については、「 ドキュメント API」 を参照してください。

var style = new sn_pdfgeneratorutils.Style();

var padding = 2.5;

style.setPaddingTop(padding);

スタイル – setTextAlignment(文字列アラインメント)

スタイルのテキスト配置を設定します。

表 : 44. パラメーター

名前	タイプ	説明
位置調整	文字列	テキストの配置位置。 有効な値： text-center:テキストを中央に揃えます。 text-justified:文字間のスペースを変更して、左右の間のテキストを完全に埋めます。最後の行は左揃えです。 text-justified-all:最後の行を含めてテキストの配置を両端揃えします。 text-left:テキストを左揃えにします。 text-right:テキストを右揃えにします。

表 : 45. 戻り値

タイプ	説明
なし

次の例は、要素テキストを中央揃えに設定する方法を示しています。

var style = new sn_pdfgeneratorutils.Style();

String alignment = "text-center";

style.setTextAlignment(alignment);

スタイル – setVerticalAlignment(文字列配置)

この要素の垂直配置を設定します。

表 : 46. パラメーター

名前	タイプ	説明
位置調整	文字列	垂直方向の配置設定。 有効な値： bottom:コンテンツを下に揃えます。 mid:コンテンツを中央に揃えます。 top:コンテンツを上部に揃えます。

表 : 47. 戻り値

タイプ	説明
なし

次の例は、要素の垂直配置を設定する方法を示しています。 ドキュメントの使用例については、「 ドキュメント API」 を参照してください。

var style = new sn_pdfgeneratorutils.Style();

var alignment = "Mid";

style.setVerticalAlignment(alignment);