pyosbxl.dto.PageSetupObject

class documentation

class PageSetupObject:

Constructor: PageSetupObject()

印刷情報設定オブジェクトです。

Method	`__init__`	コンストラクタ。インスタンスを作成します。
Method	`getAlignMarginsHeaderFooter`	ヘッダーとフッターを余白に合わせて配置するかどうか取得します。
Method	`getBlackAndWhilte`	白黒印刷するかどうか取得します。
Method	`getBottomMargin`	下のマージンを取得します。
Method	`getCenterHorizontally`	シートがページ上の横方向の中央位置に配置されているかどうか取得します。
Method	`getCenterVertically`	シートが印刷時にシートがページの垂直方向の中央に配置されているかどうか取得します。
Method	`getDifferentFirstPageHeaderFooter`	別のヘッダーやフッターが先頭ページに使用されるかどうか取得します。
Method	`getDraft`	ドラフトクオリティかどうか取得します。
Method	`getEvenFooter`	偶数ページのフッタオブジェクトを取得します。
Method	`getEvenHeader`	偶数ページのヘッダオブジェクトを取得します。
Method	`getFirstFooter`	最初のページのフッタオブジェクトを取得します。
Method	`getFirstHeader`	最初のページのヘッダオブジェクトを取得します。
Method	`getFirstPageNumber`	このシートの印刷時に使用される最初のページ番号を取得します。
Method	`getFitToPagesTall`	ワークシートの印刷時に拡大縮小する高さのページ数を取得します。
Method	`getFitToPagesWide`	ワークシートの印刷時に拡大縮小する幅のページ数を取得します。
Method	`getFooterMargin`	フッダのマージンを取得します。
Method	`getHeaderMargin`	ヘッダのマージンを取得します。
Method	`getHorizontalPrintQuality`	水平方向のDPIを取得します。
Method	`getLeftMargin`	左のマージンを取得します。
Method	`getOddAndEvenPagesHeaderFooter`	奇数ページと偶数ページに異なるヘッダとフッタを取得します。
Method	`getOddFooter`	奇数ページのフッタオブジェクトを取得します。
Method	`getOddHeader`	奇数ページのヘッダオブジェクトを取得します。
Method	`getOrder`	大きなワークシートの印刷時のページ番号の印刷の順序を取得します。
Method	`getOrientation`	印刷の向きを取得します。
Method	`getPaperSize`	印刷の用紙サイズを取得します。
Method	`getPrintArea`	印刷範囲を取得します。A1C1表記で取得します。
Method	`getPrintComments`	シートにコメントを印刷する方法を取得します。
Method	`getPrintErrors`	表示される印刷エラーの種類の設定を取得します。
Method	`getPrintGridlines`	セルの枠線をページ上に印刷するかどうかを取得します。
Method	`getPrintHeadings`	行見出しと列見出しをこのページで印刷するかどうかを取得します。
Method	`getPrintNotes`	セルノートはシートと一緒に終了ノートとして印刷するかどうかを取得します。
Method	`getPrintTitleColumnsFromCol`	印刷タイトルの列方向の開始列を取得します。
Method	`getPrintTitleColumnsToCol`	印刷タイトルの列方向の終了列を取得します。
Method	`getPrintTitleRowsFromRow`	印刷タイトルの行方向の開始行を取得します。
Method	`getPrintTitleRowsToRow`	印刷タイトルの行方向の終了行を取得します。
Method	`getRightMargin`	右のマージンを取得します。
Method	`getScaleWithDocHeaderFooter`	ヘッダとフッタを文書と一緒に拡大縮小する必要があるかどうかを取得します。
Method	`getTopMargin`	上のマージンを取得します。
Method	`getVerticalPrintQuality`	垂直方向のDPIを取得します。
Method	`getZoom`	ズーム値を取得します(パーセント)。
Method	`setAlignMarginsHeaderFooter`	ヘッダとフッタを余白に合わせて配置するかどうか設定します。
Method	`setBlackAndWhilte`	白黒印刷するかどうか設定します。
Method	`setBottomMargin`	下のマージンを設定します。
Method	`setCenterHorizontally`	シートがページ上の横方向の中央位置に配置するかどうか設定します。
Method	`setCenterVertically`	シートが印刷時にシートがページの垂直方向の中央に配置するかどうか設定します。
Method	`setDraft`	ドラフトクオリティかどうか設定します。
Method	`setFirstAndOddAndEvenFooter`	初ページ、奇数、偶数ページに別のフッダーオブジェクトを設定します。
Method	`setFirstAndOddAndEvenHeader`	初ページ、奇数、偶数ページに別のヘッダーオブジェクトを設定します。
Method	`setFirstPageNumber`	このシートの印刷時に使用される最初のページ番号を設定します。
Method	`setFitToPages`	ワークシートの印刷時に拡大縮小するページ数を設定します。
Method	`setFooter`	フッダーオブジェクトを設定します。
Method	`setFooterAndFirstFooter`	奇数、偶数ページに別のフッダーオブジェクトを設定します。
Method	`setFooterMargin`	フッダのマージンを取得します。
Method	`setHeader`	ヘッダーのマージンを設定します。
Method	`setHeaderAndFirstHeader`	初ページに別のヘッダーオブジェクトを設定します。
Method	`setHeaderMargin`	ヘッダーのマージンを設定します。
Method	`setHorizontalPrintQuality`	水平方向のDPIを設定します。
Method	`setLeftMargin`	左のマージンを設定します。
Method	`setOddAndEvenFooter`	奇数、偶数ページに別のフッダーオブジェクトを設定します。
Method	`setOddAndEvenHeader`	奇数、偶数ページに別のヘッダーオブジェクトを設定します。
Method	`setOrder`	大きなワークシートの印刷時のページ番号の印刷の順序を設定します。
Method	`setOrientation`	印刷の向きを取得します。
Method	`setPaperSize`	印刷の用紙サイズを設定します。
Method	`setPrintArea`	印刷領域を設定します。
Method	`setPrintComments`	シートにコメントを印刷する方法を設定します。
Method	`setPrintErrors`	表示される印刷エラーの種類を設定します。
Method	`setPrintGridlines`	セルの枠線をページ上に印刷するかどうかを設定します。
Method	`setPrintHeadings`	行見出しと列見出しをこのページで印刷するかどうかを設定します。
Method	`setPrintNotes`	セルノートをシートと一緒に終了ノートとして印刷するかどうかを設定します。
Method	`setPrintTitleColumns`	各ページの左側で繰り返されるセルを含む列を設定します。
Method	`setPrintTitleRows`	各ページの上側で繰り返されるセルを含む行を設定します。
Method	`setRightMargin`	右のマージンを設定します。
Method	`setScaleWithDocHeaderFooter`	ヘッダとフッタを文書と一緒に拡大縮小するかどうかを設定します。
Method	`setTopMargin`	上のマージンを設定します。
Method	`setVerticalPrintQuality`	垂直方向のDPIを設定します。
Method	`setZoom`	ズームを設定します。パーセントにて設定します。

def __init__(self): ¶

コンストラクタ。インスタンスを作成します。

def getAlignMarginsHeaderFooter(self) -> bool: ¶

ヘッダーとフッターを余白に合わせて配置するかどうか取得します。

Returns
`bool`	true: ヘッダーとフッターを余白に合わせて配置する false: ヘッダーとフッターを余白に合わせて配置しない

def getBlackAndWhilte(self) -> bool: ¶

白黒印刷するかどうか取得します。

Returns
`bool`	true: 白黒印刷する false:白黒印刷しない

def getBottomMargin(self) -> float: ¶

下のマージンを取得します。

Returns
`float`	下のマージン単位はcmです。

def getCenterHorizontally(self) -> bool: ¶

シートがページ上の横方向の中央位置に配置されているかどうか取得します。

Returns
`bool`	true: 中央位置に配置されている false: 中央位置に配置されていない

def getCenterVertically(self) -> bool: ¶

シートが印刷時にシートがページの垂直方向の中央に配置されているかどうか取得します。

Returns
`bool`	true: 垂直方向の中央に配置されている false: 垂直方向の中央に配置されていない

def getDifferentFirstPageHeaderFooter(self) -> bool: ¶

別のヘッダーやフッターが先頭ページに使用されるかどうか取得します。

Returns
`bool`	true: 先頭ページに使用される false: 先頭ページに使用されない

def getDraft(self) -> bool: ¶

ドラフトクオリティかどうか取得します。

Returns
`bool`	true: ドラフトクオリティ false: ドラフトクオリティでない

def getEvenFooter(self) -> FooterObject: ¶

偶数ページのフッタオブジェクトを取得します。

Returns
`FooterObject`	偶数ページのフッタオブジェクト

def getEvenHeader(self) -> HeaderObject: ¶

偶数ページのヘッダオブジェクトを取得します。

Returns
`HeaderObject`	偶数ページのヘッダオブジェクト

def getFirstFooter(self) -> FooterObject: ¶

最初のページのフッタオブジェクトを取得します。

Returns
`FooterObject`	最初のページのフッタオブジェクト

def getFirstHeader(self) -> HeaderObject: ¶

最初のページのヘッダオブジェクトを取得します。

Returns
`HeaderObject`	最初のページのヘッダオブジェクト

def getFirstPageNumber(self) -> int: ¶

このシートの印刷時に使用される最初のページ番号を取得します。

Returns
`int`	最初のページ番号既定値の0は自動を意味します

def getFitToPagesTall(self) -> int: ¶

ワークシートの印刷時に拡大縮小する高さのページ数を取得します。

Returns
`int`	拡大縮小する高さのページ数

def getFitToPagesWide(self) -> int: ¶

ワークシートの印刷時に拡大縮小する幅のページ数を取得します。

Returns
`int`	拡大縮小する幅のページ数

def getFooterMargin(self) -> float: ¶

フッダのマージンを取得します。

Returns
`float`	フッダのマージン単位はcmです。

def getHeaderMargin(self) -> float: ¶

ヘッダのマージンを取得します。

Returns
`float`	ヘッダのマージン単位はcmです。

def getHorizontalPrintQuality(self) -> int: ¶

水平方向のDPIを取得します。

Returns
`int`	水平方向のDPI

def getLeftMargin(self) -> float: ¶

左のマージンを取得します。

Returns
`float`	左のマージン単位はcmです。

def getOddAndEvenPagesHeaderFooter(self) -> bool: ¶

奇数ページと偶数ページに異なるヘッダとフッタを取得します。

Returns
`bool`	true: 奇数ページと偶数ページが異なるフッタ false: 通常

def getOddFooter(self) -> FooterObject: ¶

奇数ページのフッタオブジェクトを取得します。

Returns
`FooterObject`	奇数ページのフッタオブジェクト

def getOddHeader(self) -> HeaderObject: ¶

奇数ページのヘッダオブジェクトを取得します。

Returns
`HeaderObject`	奇数ページのヘッダオブジェクト

def getOrder(self) -> enums.XlOrder: ¶

大きなワークシートの印刷時のページ番号の印刷の順序を取得します。

Returns
`XlOrder`	印刷の順序

def getOrientation(self) -> enums.XlPageOrientation: ¶

印刷の向きを取得します。

Returns
`XlPageOrientation`	印刷の向き

def getPaperSize(self) -> enums.XlPaperSize: ¶

印刷の用紙サイズを取得します。

Returns
`XlPaperSize`	印刷の用紙サイズ

def getPrintArea(self) -> str: ¶

印刷範囲を取得します。A1C1表記で取得します。

Returns
`str`	印刷範囲

def getPrintComments(self) -> enums.XlPrintLocation: ¶

シートにコメントを印刷する方法を取得します。

Returns
`XlPrintLocation`	コメントを印刷する方法

def getPrintErrors(self) -> enums.XlPrintErrors: ¶

表示される印刷エラーの種類の設定を取得します。

Returns
`XlPrintErrors`	印刷エラーの種類

def getPrintGridlines(self) -> bool: ¶

セルの枠線をページ上に印刷するかどうかを取得します。

Returns
`bool`	true: セルの枠線をページ上に印刷する false: セルの枠線をページ上に印刷しない

def getPrintHeadings(self) -> bool: ¶

行見出しと列見出しをこのページで印刷するかどうかを取得します。

Returns
`bool`	true: 行見出しと列見出しを印刷する false: 行見出しと列見出しを印刷しない

def getPrintNotes(self) -> bool: ¶

セルノートはシートと一緒に終了ノートとして印刷するかどうかを取得します。

Returns
`bool`	true: セルノートはシートと一緒に終了ノートとして印刷する false: セルノートはシートと一緒に終了ノートとして印刷しない

def getPrintTitleColumnsFromCol(self) -> int: ¶

印刷タイトルの列方向の開始列を取得します。

Returns
`int`	印刷タイトルの列方向の開始列 0は印刷タイトルなしを意味します。

def getPrintTitleColumnsToCol(self) -> int: ¶

印刷タイトルの列方向の終了列を取得します。

Returns
`int`	印刷タイトルの列方向の終了列 0は印刷タイトルなしを意味します。

def getPrintTitleRowsFromRow(self) -> int: ¶

印刷タイトルの行方向の開始行を取得します。

Returns
`int`	印刷タイトルの行方向の開始行 0は印刷タイトルなしを意味します。

def getPrintTitleRowsToRow(self) -> int: ¶

印刷タイトルの行方向の終了行を取得します。

Returns
`int`	印刷タイトルの行方向の終了行 0は印刷タイトルなしを意味します。

def getRightMargin(self) -> float: ¶

右のマージンを取得します。

Returns
`float`	右のマージン単位はcmです。

def getScaleWithDocHeaderFooter(self) -> bool: ¶

ヘッダとフッタを文書と一緒に拡大縮小する必要があるかどうかを取得します。

Returns
`bool`	true:ヘッダとフッタを文書と一緒に拡大縮小する false:ヘッダとフッタを文書と一緒に拡大縮小しない

def getTopMargin(self) -> float: ¶

上のマージンを取得します。

Returns
`float`	上のマージン単位はcmです。

def getVerticalPrintQuality(self) -> int: ¶

垂直方向のDPIを取得します。

Returns
`int`	垂直方向のDPI

def getZoom(self) -> int: ¶

ズーム値を取得します(パーセント)。

Returns
`int`	ズームの許容値は、10から400パーセントです。

def setAlignMarginsHeaderFooter(self, apply: bool): ¶

ヘッダとフッタを余白に合わせて配置するかどうか設定します。

Parameters
apply:`bool`	true: ヘッダとフッタを余白に合わせて配置する false: ヘッダとフッタを余白に合わせて配置しない

def setBlackAndWhilte(self, apply: bool): ¶

白黒印刷するかどうか設定します。

Parameters
apply:`bool`	true:白黒印刷 false:通常印刷

def setBottomMargin(self, margin: float): ¶

下のマージンを設定します。

Parameters
margin:`float`	下のマージン単位はcmです。

def setCenterHorizontally(self, apply: bool): ¶

シートがページ上の横方向の中央位置に配置するかどうか設定します。

Parameters
apply:`bool`	true: 横方向の中央位置に配置する false: 横方向の中央位置に配置しない

def setCenterVertically(self, apply: bool): ¶

シートが印刷時にシートがページの垂直方向の中央に配置するかどうか設定します。

Parameters
apply:`bool`	true: 垂直方向の中央に配置する false: 垂直方向の中央に配置しない

def setDraft(self, apply: bool): ¶

ドラフトクオリティかどうか設定します。

Parameters
apply:`bool`	true: ドラフトクオリティ false: 通常

def setFirstAndOddAndEvenFooter(self, firstFooter: FooterObject, oddFooter: FooterObject, evenFooter: FooterObject): ¶

初ページ、奇数、偶数ページに別のフッダーオブジェクトを設定します。

Parameters
firstFooter:`FooterObject`	初ページのフッダーオブジェクト
oddFooter:`FooterObject`	奇数ページのフッダーオブジェクト
evenFooter:`FooterObject`	偶数ページのフッダーオブジェクト

def setFirstAndOddAndEvenHeader(self, firstHeader: HeaderObject, oddHeader: HeaderObject, evenHeader: HeaderObject): ¶

初ページ、奇数、偶数ページに別のヘッダーオブジェクトを設定します。

Parameters
firstHeader:`HeaderObject`	初ページヘッダーオブジェクト
oddHeader:`HeaderObject`	奇数ページのヘッダーオブジェクト
evenHeader:`HeaderObject`	偶数ページのヘッダーオブジェクト

def setFirstPageNumber(self, num: int): ¶

このシートの印刷時に使用される最初のページ番号を設定します。

Parameters
num:`int`	最初のページ番号 0は自動を意味します。

def setFitToPages(self, numTall: int, numWide: int): ¶

ワークシートの印刷時に拡大縮小するページ数を設定します。

setZoomメソッドで、ズームを設定すると、0になります。

Parameters
numTall:`int`	拡大縮小する縦方向のページ数 0は自動を意味します。
numWide:`int`	拡大縮小する横方向のページ数 0は自動を意味します。

def setFooter(self, footer: FooterObject): ¶

フッダーオブジェクトを設定します。

Parameters
footer:`FooterObject`	フッダーオブジェクト

def setFooterAndFirstFooter(self, footer: FooterObject, firstFooter: FooterObject): ¶

奇数、偶数ページに別のフッダーオブジェクトを設定します。

Parameters
footer:`FooterObject`	奇数ページのフッダーオブジェクト
firstFooter:`FooterObject`	偶数ページのフッダーオブジェクト

def setFooterMargin(self, margin: float): ¶

フッダのマージンを取得します。

Parameters
margin:`float`	フッダのマージン単位はcmです。

def setHeader(self, header: HeaderObject): ¶

ヘッダーのマージンを設定します。

Parameters
header:`HeaderObject`	ヘッダーのマージン単位は、cmです。

def setHeaderAndFirstHeader(self, header: HeaderObject, firstHeader: HeaderObject): ¶

初ページに別のヘッダーオブジェクトを設定します。

Parameters
header:`HeaderObject`	ヘッダーオブジェクト
firstHeader:`HeaderObject`	初ページのヘッダーオブジェクト

def setHeaderMargin(self, margin: float): ¶

ヘッダーのマージンを設定します。

Parameters
margin:`float`	ヘッダーのマージン単位は、cmです。

def setHorizontalPrintQuality(self, dpi: int): ¶

水平方向のDPIを設定します。

Parameters
dpi:`int`	水平方向のDPI

def setLeftMargin(self, margin: float): ¶

左のマージンを設定します。

Parameters
margin:`float`	左のマージン単位は、cmです。

def setOddAndEvenFooter(self, oddFooter: FooterObject, evenFooter: FooterObject): ¶

奇数、偶数ページに別のフッダーオブジェクトを設定します。

Parameters
oddFooter:`FooterObject`	奇数ページのフッダーオブジェクト
evenFooter:`FooterObject`	偶数ページのフッダーオブジェクト

def setOddAndEvenHeader(self, oddHeader: HeaderObject, evenHeader: HeaderObject): ¶

奇数、偶数ページに別のヘッダーオブジェクトを設定します。

Parameters
oddHeader:`HeaderObject`	奇数ページのヘッダーオブジェクト
evenHeader:`HeaderObject`	偶数ページのヘッダーオブジェクト

def setOrder(self, order: enums.XlOrder): ¶

大きなワークシートの印刷時のページ番号の印刷の順序を設定します。

Parameters
order:`XlOrder`	印刷の順序

def setOrientation(self, orientation: enums.XlPageOrientation): ¶

印刷の向きを取得します。

Parameters
orientation:`XlPageOrientation`	印刷の向き

def setPaperSize(self, paperSize: enums.XlPaperSize): ¶

印刷の用紙サイズを設定します。

Parameters
paperSize:`XlPaperSize`	用紙サイズ

def setPrintArea(self, area: str): ¶

印刷領域を設定します。

Parameters
area:`str`	印刷領域(A1C1)

def setPrintComments(self, location: enums.XlPrintLocation): ¶

シートにコメントを印刷する方法を設定します。

Parameters
location:`XlPrintLocation`	コメントを印刷する方法

def setPrintErrors(self, errors: enums.XlPrintErrors): ¶

表示される印刷エラーの種類を設定します。

Parameters
errors:`XlPrintErrors`	印刷エラーの種類

def setPrintGridlines(self, apply: bool): ¶

セルの枠線をページ上に印刷するかどうかを設定します。

Parameters
apply:`bool`	true: セルの枠線をページ上に印刷する false: セルの枠線をページ上に印刷しない

def setPrintHeadings(self, apply: bool): ¶

行見出しと列見出しをこのページで印刷するかどうかを設定します。

Parameters
apply:`bool`	true 行見出しと列見出しを印刷する false: 行見出しと列見出しを印刷しない

def setPrintNotes(self, apply: bool): ¶

セルノートをシートと一緒に終了ノートとして印刷するかどうかを設定します。

Parameters
apply:`bool`	true: セルノートを印刷する false: セルノートを印刷しない

def setPrintTitleColumns(self, fromCol: int, toCol: int): ¶

各ページの左側で繰り返されるセルを含む列を設定します。

Parameters
fromCol:`int`	開始列
toCol:`int`	終了列

def setPrintTitleRows(self, fromRow: int, toRow: int): ¶

各ページの上側で繰り返されるセルを含む行を設定します。

Parameters
fromRow:`int`	開始行
toRow:`int`	終了行

def setRightMargin(self, margin: float): ¶

右のマージンを設定します。

Parameters
margin:`float`	右のマージン単位は、cmです。

def setScaleWithDocHeaderFooter(self, apply: bool): ¶

ヘッダとフッタを文書と一緒に拡大縮小するかどうかを設定します。

Parameters
apply:`bool`	true: ヘッダとフッタを文書と一緒に拡大縮小する false: ヘッダとフッタを文書と一緒に拡大縮小しない

def setTopMargin(self, margin: float): ¶

上のマージンを設定します。

Parameters
margin:`float`	上のマージン単位は、cmです。

def setVerticalPrintQuality(self, dpi: int): ¶

垂直方向のDPIを設定します。

Parameters
dpi:`int`	垂直方向のDPI

def setZoom(self, percent: int): ¶

ズームを設定します。パーセントにて設定します。

setFitToPages は0に設定された状態になります。

Parameters
percent:`int`	ズーム(10～400)。単位はパーセントです。