GC.Spread.Sheets.Print.PrintInfo

クラス: PrintInfo

Sheets.Print.PrintInfo

コンストラクタ

constructor

メソッド

コンストラクタ

constructor

• new PrintInfo(sheet?)

Worksheetの印刷時に使用する情報を表します。

実例

var printInfo = new GC.Spread.Sheets.Print.PrintInfo();
printInfo.bestFitColumns(true);
printInfo.orientation(GC.Spread.Sheets.Print.PrintPageOrientation.landscape);
activeSheet.printInfo(printInfo);
spread.print(0);

パラメータ

名前	型
`sheet?`	`Worksheet`

メソッド

bestFitColumns

▸ bestFitColumns(value?): any

印刷時に列の幅を最も長いテキストの幅に合わせて調整するかどうかを取得または設定します。

実例

var printInfo = new GC.Spread.Sheets.Print.PrintInfo();
printInfo.bestFitColumns(true);
printInfo.orientation(GC.Spread.Sheets.Print.PrintPageOrientation.landscape);
printInfo.pageHeaderFooter({
    normal: {
        footer: {
            center: "SpreadJS"
        }
    }
});
activeSheet.printInfo(printInfo);
spread.print(0);

パラメータ

名前	型
`value?`	`boolean`

戻り値

any

値が設定されていない場合は、印刷時に列の幅を最も長いテキストの幅に合わせて調整するかどうかを返します。値が設定されている場合は、印刷設定情報を返します。

bestFitRows

▸ bestFitRows(value?): any

印刷時に行の高さを最も高いテキストの高さに合わせて調整するかどうかを取得または設定します。

実例

activeSheet.getCell(0,0).wordWrap(true);
activeSheet.getCell(0,0).value("The quick brown fox jumps over the lazy dog.");
var printInfo = new GC.Spread.Sheets.Print.PrintInfo();
printInfo.bestFitRows(true);
activeSheet.printInfo(printInfo);
spread.print(0);

パラメータ

名前	型
`value?`	`boolean`

戻り値

any

値が設定されていない場合は、印刷時に行の高さを最も高いテキストの高さに合わせて調整するかどうかを返します。値が設定されている場合は、印刷設定情報を返します。

blackAndWhite

▸ blackAndWhite(value?): any

白黒で印刷するかどうかを取得または設定します。

実例

activeSheet.getRange(0, 0, 5, 5).backColor("red");
var printInfo = new GC.Spread.Sheets.Print.PrintInfo();
printInfo.blackAndWhite(true);
activeSheet.printInfo(printInfo);
spread.print(0);

パラメータ

名前	型
`value?`	`boolean`

戻り値

any

値が設定されていない場合は、白黒で印刷するかどうかを返します。値が設定されている場合は、印刷設定情報を返します。

centering

▸ centering(value?): any

印刷ページのセンタリング方法を取得または設定します。

実例

var printInfo = new GC.Spread.Sheets.Print.PrintInfo();
printInfo.columnStart(0);
printInfo.columnEnd(2);
printInfo.centering(GC.Spread.Sheets.Print.PrintCentering.horizontal);
activeSheet.printInfo(printInfo);
spread.print(0);

パラメータ

名前	型
`value?`	`PrintCentering`

戻り値

any

値が設定されていない場合は、印刷ページのセンタリング方法を返します。値が設定されている場合は、印刷設定情報を返します。

columnEnd

▸ columnEnd(value?): any

印刷するセル範囲の最後の列を取得または設定します。

実例

var data = [
    ["1", "NewYork", "1968/6/8", "80", "180"],
    ["4", "NewYork", "1972/7/3", "72", "168"],
    ["5", "Washington", "1972/8/8","80", "171"],
];
activeSheet.setArray(0, 0, data);
var printInfo = new GC.Spread.Sheets.Print.PrintInfo();
printInfo.columnStart(0);
printInfo.columnEnd(2);
printInfo.centering(GC.Spread.Sheets.Print.PrintCentering.horizontal);
activeSheet.printInfo(printInfo);
spread.print(0);

パラメータ

名前	型
`value?`	`number`

戻り値

any

値が設定されていない場合は、セル範囲を印刷するときの最後の印刷列を返します。値が設定されている場合は、印刷設定情報を返します。

columnStart

▸ columnStart(value?): any

印刷するセル範囲の先頭の列を取得または設定します。

実例

var data = [
    ["1", "NewYork", "1968/6/8", "80", "180"],
    ["4", "NewYork", "1972/7/3", "72", "168"],
    ["5", "Washington", "1972/8/8","80", "171"],
];
activeSheet.setArray(0, 0, data);
var printInfo = new GC.Spread.Sheets.Print.PrintInfo();
printInfo.columnStart(2);
printInfo.columnEnd(4);
printInfo.centering(GC.Spread.Sheets.Print.PrintCentering.horizontal);
activeSheet.printInfo(printInfo);
spread.print(0);

パラメータ

名前	型
`value?`	`number`

戻り値

any

値が設定されていない場合は、セル範囲を印刷するときの最初の印刷列を返します。値が設定されている場合は、印刷設定情報を返します。

differentFirstPage

▸ differentFirstPage(value?): any

最初のページにヘッダやフッタの異なるテキストと書式を印刷するかどうかを取得または設定します。

実例

activeSheet.setArray(0, 0, new Array(60).fill(["sample text"]));
var printInfo = activeSheet.printInfo();
printInfo.differentFirstPage(true);
printInfo.pageHeaderFooter({
     first: {
         header: {
             left: "It is &A.",
             center: "&SThis is text.",
             right: "&BHeader"
         }
     }
});
activeSheet.printInfo(printInfo);
spread.print(0);

パラメータ

名前	型
`value?`	`boolean`

戻り値

any

値が設定されていない場合は、最初のページにヘッダ/フッタの異なるテキストと書式を印刷するかどうかを返します。それ以外の場合は、印刷設定情報を返します。

differentOddAndEvenPages

▸ differentOddAndEvenPages(value?): any

奇数ページと偶数ページにヘッダ/フッタの異なるテキストと書式を印刷するかどうかを取得または設定します。

実例

activeSheet.setArray(0, 0, new Array(60).fill(["sample text"]));
var printInfo = activeSheet.printInfo();
printInfo.differentOddAndEvenPages(true);
printInfo.pageHeaderFooter({
     odd: {
         header: {
             left: "odd page",
             center: "page number: &P",
             right: "&BHeader"
         }
     },
     even: {
         header: {
             left: "even page",
             center: "page number: &P",
             right: "&BHeader"
         }
     }
});
activeSheet.printInfo(printInfo);
spread.print(0);

パラメータ

名前	型
`value?`	`boolean`

戻り値

any

値が設定されていない場合は、ヘッダまたはフッタの異なるテキストと形式を奇数ページと偶数ページに印刷するかどうかを返します。それ以外の場合は、印刷設定情報を返します。

firstPageNumber

▸ firstPageNumber(value?): any

偶数ページに印刷するページ番号を取得または設定します。

実例

activeSheet.setArray(0, 0, new Array(60).fill(["sample text"]));
var printInfo = new GC.Spread.Sheets.Print.PrintInfo();
printInfo.firstPageNumber(5);
printInfo.pageHeaderFooter({
    normal: {
        header: {
            left: "page number: &N"
        }
    }
});
activeSheet.printInfo(printInfo);
spread.print(0);

パラメータ

名前	型
`value?`	`number`

戻り値

any

値が設定されていない場合は、偶数ページに印刷するページ番号を返します。それ以外の場合は、印刷設定の情報を返します。

fitPagesTall

▸ fitPagesTall(value?): any

印刷を最適化するときにチェックする縦方向のページ数を取得または設定します。

実例

activeSheet.setArray(0, 0, new Array(60).fill(["sample text"]));
var printInfo = new GC.Spread.Sheets.Print.PrintInfo();
printInfo.fitPagesTall(1);
activeSheet.printInfo(printInfo);
spread.print(0);

パラメータ

名前	型
`value?`	`number`

戻り値

any

値が設定されていない場合は、チェックする縦方向のページ数を返します。値が設定されている場合は、印刷設定情報を返します。

fitPagesWide

▸ fitPagesWide(value?): any

印刷を最適化するときにチェックする横方向のページ数を取得または設定します。

実例

activeSheet.setArray(0, 0, [new Array(16).fill("A")]);
var printInfo = new GC.Spread.Sheets.Print.PrintInfo();
printInfo.fitPagesWide(1);
activeSheet.printInfo(printInfo);
spread.print(0);

パラメータ

名前	型
`value?`	`number`

戻り値

any

値が設定されていない場合は、チェックする横方向のページ数を返します。値が設定されている場合は、印刷設定情報を返します。

margin

▸ margin(value?): any

印刷の余白（1/100インチ単位）を取得または設定します。

実例

var printInfo = new GC.Spread.Sheets.Print.PrintInfo();
printInfo.pageHeaderFooter({
    normal: {
        header: {
            left: "Header Left",
            right: "Header Right"
        },
        footer: {
            left: "Footer Left",
            center: "Footer Center",
            right: "Footer Right"
        }
    }
});
printInfo.margin({top:75, bottom:75, left:20, right:20, header:10, footer:20});
activeSheet.printInfo(printInfo);
spread.print(0);

パラメータ

名前	型
`value?`	`PrintMargins`

戻り値

any

値が設定されていない場合は、印刷の余白を返します。値が設定されている場合は、印刷設定情報を返します。

orientation

▸ orientation(value?): any

印刷時のページの向きを取得または設定します。

実例

activeSheet.setArray(0, 0, [['Title 1', 'Title 2'], [1, 2], [3, 4]]);
var printInfo = new GC.Spread.Sheets.Print.PrintInfo();
// 印刷用にページの向きを指定します。
printInfo.orientation(GC.Spread.Sheets.Print.PrintPageOrientation.landscape);
activeSheet.printInfo(printInfo);
spread.print(0);

パラメータ

名前	型
`value?`	`PrintPageOrientation`

戻り値

any

値が設定されていない場合は、印刷に使用するページの向きを返します。値が設定されている場合は、印刷設定情報を返します。

pageHeaderFooter

▸ pageHeaderFooter(value?): any

ページにカスタムヘッダ/フッタのテキストと書式を印刷するためのオプションを取得または設定します。

実例

activeSheet.setArray(0, 0, new Array(60).fill(["sample text"]));
var printInfo = new GC.Spread.Sheets.Print.PrintInfo();
printInfo.pageHeaderFooter({
     normal: {
         header: {
             left: "It is &T.",
             center: "&SThis is text.",
             right: "&BHeader"
         }
     }
});
activeSheet.printInfo(printInfo);
spread.print(0);

パラメータ

名前	型
`value?`	`IPageCustomHeaderFooterOptions`

戻り値

any

値が設定されていない場合は、ページにカスタムヘッダ/フッタのテキストと書式を印刷するためのオプションを返します。それ以外の場合は、印刷設定情報を返します。

pageOrder

▸ pageOrder(value?): any

ページの印刷順序を取得または設定します。

実例

activeSheet.setRowCount(200);
activeSheet.setColumnCount(20);
activeSheet.setArray(0, 0, Array.from({ length: 200 }, (_, i) => [i]));
activeSheet.setArray(0, 0, [Array.from({ length: 20 }, (_, i) => i)]);
var printInfo = new GC.Spread.Sheets.Print.PrintInfo();
printInfo.pageOrder(GC.Spread.Sheets.Print.PrintPageOrder.auto);
activeSheet.printInfo(printInfo);
spread.print(0);

パラメータ

名前	型
`value?`	`PrintPageOrder`

戻り値

any

値が設定されていない場合は、ページを印刷する順序を指定する値を返します。値が設定されている場合は、印刷設定情報を返します。

pageRange

▸ pageRange(value?): any

印刷のページ範囲を取得または設定します。

実例

activeSheet.setRowCount(200);
activeSheet.setArray(0, 0, Array.from({ length: 200 }, (_, i) => [i]));
var printInfo = new GC.Spread.Sheets.Print.PrintInfo();
printInfo.pageRange("1-3");
activeSheet.printInfo(printInfo);
spread.print(0);

パラメータ

名前	型
`value?`	`string`

戻り値

any

値が設定されていない場合は、ページ番号またはページ範囲を提供する文字列を返します。値が設定されている場合は、印刷設定情報を返します。

paperSize

▸ paperSize(value?): any

印刷する用紙サイズを取得または設定します。

実例

activeSheet.setArray(0, 0, new Array(20).fill(["sample text"]));
var printInfo = new GC.Spread.Sheets.Print.PrintInfo();
printInfo.paperSize(new GC.Spread.Sheets.Print.PaperSize(300, 300));
activeSheet.printInfo(printInfo);
spread.print(0);

パラメータ

名前	型
`value?`	`PaperSize`

戻り値

any

値が設定されていない場合は、印刷する用紙サイズを返します。値が設定されている場合は、印刷設定情報を返します。

qualityFactor

▸ qualityFactor(value?): any

印刷の品質ファクターを取得または設定します。

実例

activeSheet.setArray(0, 0, new Array(20).fill(["sample text"]));
var printInfo = new GC.Spread.Sheets.Print.PrintInfo();
printInfo.qualityFactor(6);
activeSheet.printInfo(printInfo);
spread.print();

パラメータ

名前	型
`value?`	`number`

戻り値

any

値が設定されていない場合は、印刷の品質ファクターを返します。値が設定されている場合は、印刷設定情報を返します。

repeatColumnEnd

▸ repeatColumnEnd(value?): any

各ページの左に印刷する列範囲の最後の列を取得または設定します。

実例

activeSheet.setArray(0, 0, [['Title 1', 'Title 2']]);
activeSheet.setArray(0, 2, [Array.from({ length: 18 }, (_, i) => i)]);
var printInfo = new GC.Spread.Sheets.Print.PrintInfo();
printInfo.repeatColumnStart(0);
printInfo.repeatColumnEnd(1);
activeSheet.printInfo(printInfo);
spread.print(); // 「Title 1」と「Title 2」が各ページに繰り返し印刷されます。

パラメータ

名前	型
`value?`	`number`

戻り値

any

値が設定されていない場合は、各ページの左に印刷する列範囲の最後の列を返します。値が設定されている場合は、印刷設定情報を返します。

repeatColumnStart

▸ repeatColumnStart(value?): any

各ページの左に印刷する列範囲の最初の列を取得または設定します。

実例

activeSheet.setArray(0, 0, [['Title 1', 'Title 2']]);
activeSheet.setArray(0, 2, [Array.from({ length: 18 }, (_, i) => i)]);
var printInfo = new GC.Spread.Sheets.Print.PrintInfo();
printInfo.repeatColumnStart(0);
printInfo.repeatColumnEnd(1);
activeSheet.printInfo(printInfo);
spread.print(); // 「Title 1」と「Title 2」が各ページに繰り返し印刷されます。

パラメータ

名前	型
`value?`	`number`

戻り値

any

値が設定されていない場合は、各ページの左に印刷する列範囲の最初の列を返します。値が設定されている場合は、印刷設定情報を返します。

repeatRowEnd

▸ repeatRowEnd(value?): any

各ページの上に印刷する行範囲の最後の行を取得または設定します。

実例

activeSheet.setArray(0, 0, [['Title 1'], ['Title 2']]);
activeSheet.setArray(2, 0, Array.from({ length: 60 }, (_, i) => [i]));
var printInfo = new GC.Spread.Sheets.Print.PrintInfo();
printInfo.repeatRowStart(0);
printInfo.repeatRowEnd(1);
activeSheet.printInfo(printInfo);
spread.print(); // 「Title 1」と「Title 2」が各ページに繰り返し印刷されます。

パラメータ

名前	型
`value?`	`number`

戻り値

any

値が設定されていない場合は、各ページの上に印刷する行範囲の最後の行を返します。値が設定されている場合は、印刷設定情報を返します。

repeatRowStart

▸ repeatRowStart(value?): any

各ページの上に印刷する行範囲の最初の行を取得または設定します。

実例

activeSheet.setArray(0, 0, [['Title 1'], ['Title 2']]);
activeSheet.setArray(2, 0, Array.from({ length: 60 }, (_, i) => [i]));
var printInfo = new GC.Spread.Sheets.Print.PrintInfo();
printInfo.repeatRowStart(0);
printInfo.repeatRowEnd(1);
activeSheet.printInfo(printInfo);
spread.print(); // 「Title 1」と「Title 2」が各ページに繰り返し印刷されます。

パラメータ

名前	型
`value?`	`number`

戻り値

any

値が設定されていない場合は、各ページの上に印刷する行範囲の最初の行を返します。値が設定されている場合は、印刷設定情報を返します。

rowEnd

▸ rowEnd(value?): any

印刷するセル範囲の最後の行を取得または設定します。

実例

activeSheet.setColumnCount(3);
activeSheet.setArray(0, 0, new Array(60).fill(["sample text"]));
var printInfo = new GC.Spread.Sheets.Print.PrintInfo();
printInfo.rowStart(0);
printInfo.rowEnd(2);
activeSheet.printInfo(printInfo);
spread.print(0);

パラメータ

名前	型
`value?`	`number`

戻り値

any

値が設定されていない場合は、セル範囲を印刷するときの最後の印刷行を返します。値が設定されている場合は、印刷設定情報を返します。

rowStart

▸ rowStart(value?): any

印刷するセル範囲の先頭の行を取得または設定します。

実例

activeSheet.setColumnCount(3);
activeSheet.setArray(0, 0, new Array(60).fill(["sample text"]));
var printInfo = new GC.Spread.Sheets.Print.PrintInfo();
printInfo.rowStart(0);
printInfo.rowEnd(2);
activeSheet.printInfo(printInfo);
spread.print(0);

パラメータ

名前	型
`value?`	`number`

戻り値

any

値が設定されていない場合は、セル範囲を印刷するときの最初の印刷行を返します。値が設定されている場合は、印刷設定情報を返します。

showBorder

▸ showBorder(value?): any

コントロール全体の周囲に輪郭（境界）線を印刷するかどうかを取得または設定します。

実例

activeSheet.setArray(0, 0, [['Title 1', 'Title 2'], [1, 2], [3, 4]]);
var printInfo = new GC.Spread.Sheets.Print.PrintInfo();
printInfo.showBorder(false);
activeSheet.printInfo(printInfo);
spread.print(0);

パラメータ

名前	型
`value?`	`boolean`

戻り値

any

値が設定されていない場合は、コントロール全体の周囲に輪郭（境界）線を印刷するかどうかを返します。値が設定されている場合は、印刷設定情報を返します。

showColumnHeader

▸ showColumnHeader(value?): any

列ヘッダを印刷するかどうかを取得または設定します。

実例

activeSheet.setArray(0, 0, [['Title 1', 'Title 2'], [1, 2], [3, 4]]);
var printInfo = new GC.Spread.Sheets.Print.PrintInfo();
printInfo.showColumnHeader(GC.Spread.Sheets.Print.PrintVisibilityType.hide);
activeSheet.printInfo(printInfo);
spread.print(0);

パラメータ

名前	型
`value?`	`PrintVisibilityType`

戻り値

any

値が設定されていない場合は、列ヘッダを印刷するかどうかを返します。値が設定されている場合は、印刷設定情報を返します。

showGridLine

▸ showGridLine(value?): any

グリッド線を印刷するかどうかを表す値を取得または設定します。

実例

activeSheet.setArray(0, 0, [['Title 1', 'Title 2'], [1, 2], [3, 4]]);
var printInfo = new GC.Spread.Sheets.Print.PrintInfo();
printInfo.showGridLine(true);
activeSheet.printInfo(printInfo);
spread.print(0);

パラメータ

名前	型
`value?`	`boolean`

戻り値

any

値が設定されていない場合は、グリッド線を印刷するかどうかを返します。値が設定されている場合は、印刷設定情報を返します。

showRowHeader

▸ showRowHeader(value?): any

行ヘッダを印刷するかどうかを取得または設定します。

実例

activeSheet.setArray(0, 0, [['Title 1', 'Title 2'], [1, 2], [3, 4]]);
var printInfo = new GC.Spread.Sheets.Print.PrintInfo();
printInfo.showRowHeader(GC.Spread.Sheets.Print.PrintVisibilityType.hide);
activeSheet.printInfo(printInfo);
spread.print(0);

パラメータ

名前	型
`value?`	`PrintVisibilityType`

戻り値

any

値が設定されていない場合は、行ヘッダを印刷するかどうかを返します。値が設定されている場合は、印刷設定情報を返します。

useMax

▸ useMax(value?): any

データを含む行および列のみを印刷するかどうかを取得または設定します。

実例

activeSheet.setArray(0, 0, [['Title 1', 'Title 2'], [1, 2], [3, 4]]);
var printInfo = new GC.Spread.Sheets.Print.PrintInfo();
printInfo.useMax(false);
activeSheet.printInfo(printInfo);
spread.print(0);

パラメータ

名前	型
`value?`	`boolean`

戻り値

any

値が設定されていない場合は、データを含む行および列のみを印刷するかどうかを返します。値が設定されている場合は、印刷設定情報を返します。

watermark

▸ watermark(value?): any

すべてのウォーターマークを取得または設定します。

実例

// 次のサンプルコードは、ウォーターマークを設定する方法を示します。
var printInfo = activeSheet.printInfo();
printInfo.watermark([{x:0, y:0, width:100, height:100, imageSrc:".image/watermark.jpg", page:"all"}]);
activeSheet.printInfo(printInfo);
spread.print(0);

パラメータ

名前	型
`value?`	`IWatermarkItem`[]

戻り値

any

ウォーターマークの項目。

zoomFactor

▸ zoomFactor(value?): any

印刷に使用する倍率を取得または設定します。

実例

activeSheet.setArray(0, 0, [['Title 1', 'Title 2'], [1, 2], [3, 4]]);
var printInfo = new GC.Spread.Sheets.Print.PrintInfo();
printInfo.zoomFactor(2);
activeSheet.printInfo(printInfo);
spread.print(0);

パラメータ

名前	型
`value?`	`number`

戻り値

any

値が設定されていない場合は、印刷するワークシートの拡大/縮小率を指定する値を返します。値が設定されている場合は、印刷設定情報を返します。

GC.Spread.Sheets.Print.PrintInfo

クラス: PrintInfo

Table of contents

コンストラクタ

メソッド

コンストラクタ

constructor

パラメータ

メソッド

bestFitColumns

パラメータ

戻り値

bestFitRows

パラメータ

戻り値

blackAndWhite

パラメータ

戻り値

centering

パラメータ

戻り値

columnEnd

パラメータ

戻り値

columnStart

パラメータ

戻り値

differentFirstPage

パラメータ

戻り値

differentOddAndEvenPages

パラメータ

戻り値

firstPageNumber

パラメータ

戻り値

fitPagesTall

パラメータ

戻り値

fitPagesWide

パラメータ

戻り値

margin

パラメータ

戻り値

orientation

パラメータ

戻り値

pageHeaderFooter

パラメータ

戻り値

pageOrder

パラメータ

戻り値

pageRange

パラメータ

戻り値

paperSize

パラメータ

戻り値

qualityFactor

パラメータ

戻り値

repeatColumnEnd

パラメータ

戻り値

repeatColumnStart

パラメータ

戻り値

repeatRowEnd

パラメータ

戻り値

repeatRowStart

パラメータ

戻り値

rowEnd

パラメータ

戻り値

rowStart

パラメータ