Word.PageSetup class
Representa as definições de configuração da página para um documento ou secção Word.
- Extends
Comentários
Propriedades
| book |
Especifica se o Microsoft Word imprime o documento como um folheto. |
| book |
Especifica o número de páginas para cada folheto. |
| book |
Especifica se o Microsoft Word inverte a ordem de impressão para a impressão de pastas de livros de documentos de idioma bidirecional ou asiático. |
| bottom |
Especifica a distância (em pontos) entre o limite inferior da página e o limite inferior do corpo de texto. |
| chars |
Especifica o número de carateres por linha na grelha do documento. |
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| different |
Especifica se a primeira página tem um cabeçalho e rodapé diferentes. |
| footer |
Especifica a distância entre o rodapé e a parte inferior da página em pontos. |
| gutter | Especifica a quantidade (em pontos) de espaço de margem adicional adicionado a cada página num documento ou secção para enlace. |
| gutter |
Especifica em que lado a medianiz aparece num documento. |
| gutter |
Especifica se o Microsoft Word utiliza medianiz para o documento atual com base num idioma da direita para a esquerda ou num idioma da esquerda para a direita. |
| header |
Especifica a distância entre o cabeçalho e a parte superior da página em pontos. |
| layout |
Especifica o modo de esquema para o documento atual. |
| left |
Especifica a distância (em pontos) entre o limite esquerdo da página e o limite esquerdo do corpo de texto. |
| line |
Especifica um |
| lines |
Especifica o número de linhas por página na grelha do documento. |
| mirror |
Especifica se as margens interiores e externas das páginas opostas têm a mesma largura. |
| odd |
Especifica se as páginas pares e ímpares têm cabeçalhos e rodapés diferentes. |
| orientation | Especifica a orientação da página. |
| page |
Especifica a altura da página em pontos. |
| page |
Especifica a largura da página em pontos. |
| paper |
Especifica o tamanho do papel da página. |
| right |
Especifica a distância (em pontos) entre o limite direito da página e o limite direito do corpo de texto. |
| section |
Especifica o sentido de leitura e o alinhamento das secções especificadas. |
| section |
Especifica o tipo de quebra de secção para o objeto especificado. |
| show |
Especifica se pretende mostrar a grelha. |
| suppress |
Especifica se as notas de fim são impressas no final da secção seguinte que não suprime as notas de fim. |
| text |
Obtém um |
| top |
Especifica a margem superior da página em pontos. |
| two |
Especifica se pretende imprimir duas páginas por folha. |
| vertical |
Especifica o alinhamento vertical do texto em cada página num documento ou secção. |
Métodos
| load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| set(properties, options) | Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo. |
| set(properties) | Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente. |
| set |
Define a formatação de configuração de página especificada como padrão para o documento ativo e para todos os novos documentos baseados no modelo ativo. |
| toggle |
Alterna entre retrato e paisagem a orientação de página de um documento ou seção. |
| toJSON() | Substitui o método JavaScript |
| track() | Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este objeto entre |
| untrack() | Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta chamada é abreviada para context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Terá de chamar |
Detalhes da propriedade
bookFoldPrinting
Especifica se o Microsoft Word imprime o documento como um folheto.
bookFoldPrinting: boolean;
Valor da propriedade
boolean
Comentários
bookFoldPrintingSheets
Especifica o número de páginas para cada folheto.
bookFoldPrintingSheets: number;
Valor da propriedade
number
Comentários
bookFoldReversePrinting
Especifica se o Microsoft Word inverte a ordem de impressão para a impressão de pastas de livros de documentos de idioma bidirecional ou asiático.
bookFoldReversePrinting: boolean;
Valor da propriedade
boolean
Comentários
bottomMargin
Especifica a distância (em pontos) entre o limite inferior da página e o limite inferior do corpo de texto.
bottomMargin: number;
Valor da propriedade
number
Comentários
charsLine
Especifica o número de carateres por linha na grelha do documento.
charsLine: number;
Valor da propriedade
number
Comentários
context
O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
context: RequestContext;
Valor da propriedade
differentFirstPageHeaderFooter
Especifica se a primeira página tem um cabeçalho e rodapé diferentes.
differentFirstPageHeaderFooter: boolean;
Valor da propriedade
boolean
Comentários
footerDistance
Especifica a distância entre o rodapé e a parte inferior da página em pontos.
footerDistance: number;
Valor da propriedade
number
Comentários
gutter
Especifica a quantidade (em pontos) de espaço de margem adicional adicionado a cada página num documento ou secção para enlace.
gutter: number;
Valor da propriedade
number
Comentários
gutterPosition
Especifica em que lado a medianiz aparece num documento.
gutterPosition: Word.GutterPosition | "Left" | "Right" | "Top";
Valor da propriedade
Word.GutterPosition | "Left" | "Right" | "Top"
Comentários
gutterStyle
Especifica se o Microsoft Word utiliza medianiz para o documento atual com base num idioma da direita para a esquerda ou num idioma da esquerda para a direita.
gutterStyle: Word.GutterStyle | "Bidirectional" | "Latin";
Valor da propriedade
Word.GutterStyle | "Bidirectional" | "Latin"
Comentários
headerDistance
Especifica a distância entre o cabeçalho e a parte superior da página em pontos.
headerDistance: number;
Valor da propriedade
number
Comentários
layoutMode
Especifica o modo de esquema para o documento atual.
layoutMode: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko";
Valor da propriedade
Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"
Comentários
leftMargin
Especifica a distância (em pontos) entre o limite esquerdo da página e o limite esquerdo do corpo de texto.
leftMargin: number;
Valor da propriedade
number
Comentários
lineNumbering
Especifica um LineNumbering objeto que representa os números de linha do PageSetup objeto.
lineNumbering: Word.LineNumbering;
Valor da propriedade
Comentários
linesPage
Especifica o número de linhas por página na grelha do documento.
linesPage: number;
Valor da propriedade
number
Comentários
mirrorMargins
Especifica se as margens interiores e externas das páginas opostas têm a mesma largura.
mirrorMargins: boolean;
Valor da propriedade
boolean
Comentários
oddAndEvenPagesHeaderFooter
Especifica se as páginas pares e ímpares têm cabeçalhos e rodapés diferentes.
oddAndEvenPagesHeaderFooter: boolean;
Valor da propriedade
boolean
Comentários
orientation
Especifica a orientação da página.
orientation: Word.PageOrientation | "Portrait" | "Landscape";
Valor da propriedade
Word.PageOrientation | "Portrait" | "Landscape"
Comentários
pageHeight
Especifica a altura da página em pontos.
pageHeight: number;
Valor da propriedade
number
Comentários
pageWidth
Especifica a largura da página em pontos.
pageWidth: number;
Valor da propriedade
number
Comentários
paperSize
Especifica o tamanho do papel da página.
paperSize: Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom";
Valor da propriedade
Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom"
Comentários
rightMargin
Especifica a distância (em pontos) entre o limite direito da página e o limite direito do corpo de texto.
rightMargin: number;
Valor da propriedade
number
Comentários
sectionDirection
Especifica o sentido de leitura e o alinhamento das secções especificadas.
sectionDirection: Word.SectionDirection | "RightToLeft" | "LeftToRight";
Valor da propriedade
Word.SectionDirection | "RightToLeft" | "LeftToRight"
Comentários
sectionStart
Especifica o tipo de quebra de secção para o objeto especificado.
sectionStart: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage";
Valor da propriedade
Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"
Comentários
showGrid
Especifica se pretende mostrar a grelha.
showGrid: boolean;
Valor da propriedade
boolean
Comentários
suppressEndnotes
Especifica se as notas de fim são impressas no final da secção seguinte que não suprime as notas de fim.
suppressEndnotes: boolean;
Valor da propriedade
boolean
Comentários
textColumns
Obtém um TextColumnCollection objeto que representa o conjunto de colunas de texto do PageSetup objeto.
readonly textColumns: Word.TextColumnCollection;
Valor da propriedade
Comentários
topMargin
Especifica a margem superior da página em pontos.
topMargin: number;
Valor da propriedade
number
Comentários
twoPagesOnOne
Especifica se pretende imprimir duas páginas por folha.
twoPagesOnOne: boolean;
Valor da propriedade
boolean
Comentários
verticalAlignment
Especifica o alinhamento vertical do texto em cada página num documento ou secção.
verticalAlignment: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom";
Valor da propriedade
Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"
Comentários
Detalhes do método
load(options)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(options?: Word.Interfaces.PageSetupLoadOptions): Word.PageSetup;
Parâmetros
Fornece opções para as propriedades do objeto a carregar.
Retornos
load(propertyNames)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNames?: string | string[]): Word.PageSetup;
Parâmetros
- propertyNames
-
string | string[]
Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
Retornos
load(propertyNamesAndPaths)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.PageSetup;
Parâmetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select é uma cadeia delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.
Retornos
set(properties, options)
Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.
set(properties: Interfaces.PageSetupUpdateData, options?: OfficeExtension.UpdateOptions): void;
Parâmetros
- properties
- Word.Interfaces.PageSetupUpdateData
Um objeto JavaScript com propriedades que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.
- options
- OfficeExtension.UpdateOptions
Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de leitura.
Retornos
void
set(properties)
Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.
set(properties: Word.PageSetup): void;
Parâmetros
- properties
- Word.PageSetup
Retornos
void
setAsTemplateDefault()
Define a formatação de configuração de página especificada como padrão para o documento ativo e para todos os novos documentos baseados no modelo ativo.
setAsTemplateDefault(): void;
Retornos
void
Comentários
togglePortrait()
Alterna entre retrato e paisagem a orientação de página de um documento ou seção.
togglePortrait(): void;
Retornos
void
Comentários
toJSON()
Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Word.PageSetup é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.PageSetupData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Word.Interfaces.PageSetupData;
Retornos
track()
Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este objeto entre .sync chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, terá de adicionar o objeto à coleção de objetos controlados quando o objeto foi criado pela primeira vez. Se este objeto fizer parte de uma coleção, também deve controlar a coleção principal.
track(): Word.PageSetup;
Retornos
untrack()
Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta chamada é abreviada para context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Terá de chamar context.sync() antes de a libertação da memória ser aplicada.
untrack(): Word.PageSetup;