ExcelScript.RangeFormat interface

Referenz

Paket:: ExcelScript

Gibt ein Formatobjekt zurück, das die Schriftart des Bereichs, Füllung, Rahmen, die Ausrichtung und andere Eigenschaften verschachtelt.

Hinweise

Beispiele

/**
 * This script applies some simple formatting to the top row of the used range.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the top row of the used range in the current worksheet.
  const selectedSheet = workbook.getActiveWorksheet();
  const topRow = selectedSheet.getUsedRange().getRow(0);

  // For the top row, set the fill to black, the font color to white, and the font to be bold.
  const format: ExcelScript.RangeFormat = topRow.getFormat();
  format.getFill().setColor("black");
  format.getFont().setColor("white");
  format.getFont().setBold(true);
}

Methoden

adjustIndent(amount)	Passt den Einzug der Bereichsformatierung an. Der Einzugswert reicht von 0 bis 250 und wird in Zeichen gemessen.
autofitColumns()	Ändert die Breite der Spalten des aktuellen Bereichs, um basierend auf den aktuellen Daten in den Spalten die optimale Breite zu erzielen.
autofitRows()	Ändert die Höhe der Zeilen des aktuellen Bereichs, um basierend auf den aktuellen Daten in den Zeilen die optimale Höhe zu erzielen.
getAutoIndent()	Gibt an, ob Text automatisch eingezogen wird, wenn die Textausrichtung auf die gleiche Verteilung festgelegt ist.
getBorders()	Auflistung von Border-Objekten, die für den gesamten ausgewählten Bereich gelten.
getColumnWidth()	Gibt die Breite aller Spalten innerhalb des Bereichs an. Wenn die Spaltenbreiten nicht einheitlich sind, `null` wird zurückgegeben.
getFill()	Gibt das Fill-Objekt an, das für den gesamten Bereich definiert ist.
getFont()	Gibt das Font-Objekt an, das für den gesamten Bereich definiert ist.
getHorizontalAlignment()	Stellt die horizontale Ausrichtung für das angegebene Objekt dar. Weitere Informationen finden Sie unter `ExcelScript.HorizontalAlignment` .
getIndentLevel()	Eine ganze Zahl zwischen 0 und 250, die die Einzugsebene angibt.
getProtection()	Gibt das Formatschutz-Objekt für einen Bereich zurück.
getRangeBorder(index)	Ruft ein Rahmen-Objekt ab, das den Namen verwendet
getRangeBorderTintAndShade()	Gibt ein Double an, das eine Farbe für Bereichsgrenzen aufhellt oder abdunknet. Der Wert liegt zwischen -1 (dunkelster) und 1 (hellste), mit 0 für die ursprüngliche Farbe. Ein `null` -Wert gibt an, dass die gesamte Rahmenauflistung keine einheitliche `tintAndShade` Einstellung aufweist.
getReadingOrder()	Die Leserichtung für den Bereich.
getRowHeight()	Die Höhe aller Zeilen im Bereich. Wenn die Zeilenhöhen nicht einheitlich sind, `null` wird zurückgegeben.
getShrinkToFit()	Gibt an, ob der Text automatisch verkleinert wird, um in die verfügbare Spaltenbreite einzupassen.
getTextOrientation()	Die Textausrichtung aller Zellen innerhalb des Bereichs. Die Textausrichtung sollte eine ganze Zahl zwischen -90 und 90 oder 180 für vertikal ausgerichteten Text sein. Wenn die Ausrichtung innerhalb eines Bereichs nicht einheitlich ist, `null` wird zurückgegeben.
getUseStandardHeight()	Bestimmt, ob die Zeilenhöhe des `Range` Objekts der Standardhöhe des Blatts entspricht. Gibt zurück `true` , wenn die Zeilenhöhe des `Range` Objekts der Standardhöhe des Blatts entspricht. Gibt zurück `null` , wenn der Bereich mehr als eine Zeile enthält und die Zeilen nicht alle dieselbe Höhe aufweisen. Gibt andernfalls zurück `false` .
getUseStandardWidth()	Gibt an, ob die Spaltenbreite des `Range` Objekts der Standardbreite des Blatts entspricht. Gibt zurück `true` , wenn die Spaltenbreite des `Range` Objekts der Standardbreite des Blatts entspricht. Gibt zurück `null` , wenn der Bereich mehr als eine Spalte enthält und die Spalten nicht alle dieselbe Höhe aufweisen. Gibt andernfalls zurück `false` .
getVerticalAlignment()	Stellt die vertikale Ausrichtung für das angegebene Objekt dar. Weitere Informationen finden Sie unter `ExcelScript.VerticalAlignment` .
getWrapText()	Gibt an, ob Excel den Text im -Objekt umschließt. Ein `null` -Wert gibt an, dass der gesamte Bereich keine einheitliche Umbrucheinstellung aufweist.
setAutoIndent(autoIndent)	Gibt an, ob Text automatisch eingezogen wird, wenn die Textausrichtung auf die gleiche Verteilung festgelegt ist.
setColumnWidth(columnWidth)	Gibt die Breite aller Spalten innerhalb des Bereichs an.
setHorizontalAlignment(horizontalAlignment)	Stellt die horizontale Ausrichtung für das angegebene Objekt dar. Weitere Informationen finden Sie unter `ExcelScript.HorizontalAlignment` .
setIndentLevel(indentLevel)	Eine ganze Zahl zwischen 0 und 250, die die Einzugsebene angibt.
setRangeBorderTintAndShade(rangeBorderTintAndShade)	Gibt ein Double an, das eine Farbe für Bereichsgrenzen aufhellt oder abdunknet. Der Wert liegt zwischen -1 (dunkelster) und 1 (hellste), mit 0 für die ursprüngliche Farbe. Ein `null` -Wert gibt an, dass die gesamte Rahmenauflistung keine einheitliche `tintAndShade` Einstellung aufweist.
setReadingOrder(readingOrder)	Die Leserichtung für den Bereich.
setRowHeight(rowHeight)	Gibt die Höhe aller Zeilen im Bereich an.
setShrinkToFit(shrinkToFit)	Gibt an, ob der Text automatisch verkleinert wird, um in die verfügbare Spaltenbreite einzupassen.
setTextOrientation(textOrientation)	Die Textausrichtung aller Zellen innerhalb des Bereichs. Die Textausrichtung sollte eine ganze Zahl zwischen -90 und 90 oder 180 für vertikal ausgerichteten Text sein. Wenn die Ausrichtung innerhalb eines Bereichs nicht einheitlich ist, `null` wird zurückgegeben.
setUseStandardHeight(useStandardHeight)	Bestimmt, ob die Zeilenhöhe des `Range` Objekts der Standardhöhe des Blatts entspricht. Hinweis: Diese Eigenschaft soll nur auf `true`festgelegt werden. Das Festlegen auf hat `false` keine Auswirkungen.
setUseStandardWidth(useStandardWidth)	Gibt an, ob die Spaltenbreite des `Range` Objekts der Standardbreite des Blatts entspricht. Hinweis: Diese Eigenschaft soll nur auf `true`festgelegt werden. Das Festlegen auf hat `false` keine Auswirkungen.
setVerticalAlignment(verticalAlignment)	Stellt die vertikale Ausrichtung für das angegebene Objekt dar. Weitere Informationen finden Sie unter `ExcelScript.VerticalAlignment` .
setWrapText(wrapText)	Gibt an, ob Excel den Text im -Objekt umschließt. Ein `null` -Wert gibt an, dass der gesamte Bereich keine einheitliche Umbrucheinstellung aufweist.

Details zur Methode

adjustIndent(amount)

Passt den Einzug der Bereichsformatierung an. Der Einzugswert reicht von 0 bis 250 und wird in Zeichen gemessen.

adjustIndent(amount: number): void;

Parameter

amount: number

Die Anzahl der Zeichenräume, um die der aktuelle Einzug angepasst wird. Dieser Wert sollte zwischen -250 und 250 sein. Hinweis: Wenn der Betrag die Einzugsebene über 250 erhöhen würde, bleibt die Einzugsebene bei 250. Wenn der Betrag die Einzugsebene unter 0 senken würde, bleibt die Einzugsebene 0.

Gibt zurück

void

Beispiele

/**
 * This script adjusts the indentation of a specific table column.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first table in the current worksheet.
  const selectedSheet = workbook.getActiveWorksheet();
  const table = selectedSheet.getTables()[0];

  // Get the data range of the second column.
  const secondColumn = table.getColumn(2);
  const data = secondColumn.getRangeBetweenHeaderAndTotal();

  // Add an indentation of 1 character space to the data range.
  data.getFormat().adjustIndent(1);
}

autofitColumns()

Ändert die Breite der Spalten des aktuellen Bereichs, um basierend auf den aktuellen Daten in den Spalten die optimale Breite zu erzielen.

autofitColumns(): void;

Gibt zurück

void

Beispiele

/**
 * This script creates a new table from existing data and autofits the columns.
 */
function main(workbook: ExcelScript.Workbook) {
  const currentSheet = workbook.getActiveWorksheet();
  const usedRange = currentSheet.getUsedRange();

  // Create the table.
  const table = currentSheet.addTable(usedRange, true);

  // Format the table columns.
  table.getRange().getFormat().autofitColumns();
}

autofitRows()

Ändert die Höhe der Zeilen des aktuellen Bereichs, um basierend auf den aktuellen Daten in den Zeilen die optimale Höhe zu erzielen.

autofitRows(): void;

Gibt zurück

void

Beispiele

/**
 * This script creates a new table from existing data and autofits the rows.
 */
function main(workbook: ExcelScript.Workbook) {
  const currentSheet = workbook.getActiveWorksheet();
  const usedRange = currentSheet.getUsedRange();

  // Create the table.
  const table = currentSheet.addTable(usedRange, true);

  // Format the table rows.
  table.getRange().getFormat().autofitRows();
}

getAutoIndent()

Gibt an, ob Text automatisch eingezogen wird, wenn die Textausrichtung auf die gleiche Verteilung festgelegt ist.

getAutoIndent(): boolean;

Gibt zurück

boolean

getBorders()

Auflistung von Border-Objekten, die für den gesamten ausgewählten Bereich gelten.

getBorders(): RangeBorder[];

Gibt zurück

ExcelScript.RangeBorder[]

getColumnWidth()

Gibt die Breite aller Spalten innerhalb des Bereichs an. Wenn die Spaltenbreiten nicht einheitlich sind, null wird zurückgegeben.

getColumnWidth(): number;

Gibt zurück

number

Beispiele

/**
 * This script doubles the column width for every column in the active worksheet's used range.
 */
function main(workbook: ExcelScript.Workbook) {
  const currentSheet = workbook.getActiveWorksheet();
  const usedRange = currentSheet.getUsedRange();

  // To optimize performance, get all the current row heights before setting them.
  let currentWidths = Array<number>(usedRange.getColumnCount());
  for (let column = 0; column < currentWidths.length; column++) {
    currentWidths[column] = usedRange.getColumn(column).getFormat().getColumnWidth();
  }

  // Set the new column widths.
  for (let column = 0; column < currentWidths.length; column++) {
    usedRange.getFormat().setColumnWidth(currentWidths[column] * 2);
  }

getFill()

Gibt das Fill-Objekt an, das für den gesamten Bereich definiert ist.

getFill(): RangeFill;

Gibt zurück

ExcelScript.RangeFill

Beispiele

/**
 * This script gives the total row of a table a green color fill.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first table in the workbook.
  let table = workbook.getTables()[0];

  // Get the range for the total row of the table.
  let totalRange = table.getTotalRowRange();

  // Set the fill color to green.
  totalRange.getFormat().getFill().setColor("green");
}

getFont()

Gibt das Font-Objekt an, das für den gesamten Bereich definiert ist.

getFont(): RangeFont;

Gibt zurück

ExcelScript.RangeFont

Beispiele

/**
 * This script bolds the text of cell A1.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get A1 on the current worksheet.
  const cell = workbook.getActiveWorksheet().getCell(0,0);

  // Bold the font for that cell
  cell.getFormat().getFont().setBold(true);
}

getHorizontalAlignment()

Stellt die horizontale Ausrichtung für das angegebene Objekt dar. Weitere Informationen finden Sie unter ExcelScript.HorizontalAlignment .

getHorizontalAlignment(): HorizontalAlignment;

Gibt zurück

ExcelScript.HorizontalAlignment

getIndentLevel()

Eine ganze Zahl zwischen 0 und 250, die die Einzugsebene angibt.

getIndentLevel(): number;

Gibt zurück

number

getProtection()

Gibt das Formatschutz-Objekt für einen Bereich zurück.

getProtection(): FormatProtection;

Gibt zurück

ExcelScript.FormatProtection

getRangeBorder(index)

Ruft ein Rahmen-Objekt ab, das den Namen verwendet

getRangeBorder(index: BorderIndex): RangeBorder;

Parameter

index: ExcelScript.BorderIndex

Index-Wert des abzurufenden Rahmen-Objekts. Weitere Informationen finden Sie unter ExcelScript.BorderIndex .

Gibt zurück

ExcelScript.RangeBorder

Beispiele

/**
 * This script adds a border around the outside of a range.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get a range from the current worksheet.
  let range = workbook.getActiveWorksheet().getRange("B2:E15");

  // Add a border around the whole bounding range.
  let format = range.getFormat();
  format.getRangeBorder(ExcelScript.BorderIndex.edgeTop).setStyle(ExcelScript.BorderLineStyle.continuous); // Top border
  format.getRangeBorder(ExcelScript.BorderIndex.edgeBottom).setStyle(ExcelScript.BorderLineStyle.continuous); // Bottom border
  format.getRangeBorder(ExcelScript.BorderIndex.edgeLeft).setStyle(ExcelScript.BorderLineStyle.continuous); // Left border
  format.getRangeBorder(ExcelScript.BorderIndex.edgeRight).setStyle(ExcelScript.BorderLineStyle.continuous); // Right border
}

getRangeBorderTintAndShade()

Gibt ein Double an, das eine Farbe für Bereichsgrenzen aufhellt oder abdunknet. Der Wert liegt zwischen -1 (dunkelster) und 1 (hellste), mit 0 für die ursprüngliche Farbe. Ein null -Wert gibt an, dass die gesamte Rahmenauflistung keine einheitliche tintAndShade Einstellung aufweist.

getRangeBorderTintAndShade(): number;

Gibt zurück

number

getReadingOrder()

Die Leserichtung für den Bereich.

getReadingOrder(): ReadingOrder;

Gibt zurück

ExcelScript.ReadingOrder

getRowHeight()

Die Höhe aller Zeilen im Bereich. Wenn die Zeilenhöhen nicht einheitlich sind, null wird zurückgegeben.

getRowHeight(): number;

Gibt zurück

number

Beispiele

/**
 * This script doubles the row height for every row in the active worksheet's used range.
 */
function main(workbook: ExcelScript.Workbook) {
  const currentSheet = workbook.getActiveWorksheet();
  const usedRange = currentSheet.getUsedRange();

  // To optimize performance, get all the current row heights before setting them.
  let currentHeights = Array<number>(usedRange.getRowCount());
  for (let row = 0; row < currentHeights.length; row++) {
    currentHeights[row] = usedRange.getRow(row).getFormat().getRowHeight();
  }

  // Set the new row heights.
  for (let row = 0; row < currentHeights.length; row++) {
    usedRange.getFormat().setRowHeight(currentHeights[row] * 2);
  }
}

getShrinkToFit()

Gibt an, ob der Text automatisch verkleinert wird, um in die verfügbare Spaltenbreite einzupassen.

getShrinkToFit(): boolean;

Gibt zurück

boolean

getTextOrientation()

Die Textausrichtung aller Zellen innerhalb des Bereichs. Die Textausrichtung sollte eine ganze Zahl zwischen -90 und 90 oder 180 für vertikal ausgerichteten Text sein. Wenn die Ausrichtung innerhalb eines Bereichs nicht einheitlich ist, null wird zurückgegeben.

getTextOrientation(): number;

Gibt zurück

number

getUseStandardHeight()

Bestimmt, ob die Zeilenhöhe des Range Objekts der Standardhöhe des Blatts entspricht. Gibt zurück true , wenn die Zeilenhöhe des Range Objekts der Standardhöhe des Blatts entspricht. Gibt zurück null , wenn der Bereich mehr als eine Zeile enthält und die Zeilen nicht alle dieselbe Höhe aufweisen. Gibt andernfalls zurück false .

getUseStandardHeight(): boolean;

Gibt zurück

boolean

getUseStandardWidth()

Gibt an, ob die Spaltenbreite des Range Objekts der Standardbreite des Blatts entspricht. Gibt zurück true , wenn die Spaltenbreite des Range Objekts der Standardbreite des Blatts entspricht. Gibt zurück null , wenn der Bereich mehr als eine Spalte enthält und die Spalten nicht alle dieselbe Höhe aufweisen. Gibt andernfalls zurück false .

getUseStandardWidth(): boolean;

Gibt zurück

boolean

getVerticalAlignment()

Stellt die vertikale Ausrichtung für das angegebene Objekt dar. Weitere Informationen finden Sie unter ExcelScript.VerticalAlignment .

getVerticalAlignment(): VerticalAlignment;

Gibt zurück

ExcelScript.VerticalAlignment

getWrapText()

Gibt an, ob Excel den Text im -Objekt umschließt. Ein null -Wert gibt an, dass der gesamte Bereich keine einheitliche Umbrucheinstellung aufweist.

getWrapText(): boolean;

Gibt zurück

boolean

setAutoIndent(autoIndent)

Gibt an, ob Text automatisch eingezogen wird, wenn die Textausrichtung auf die gleiche Verteilung festgelegt ist.

setAutoIndent(autoIndent: boolean): void;

Parameter

autoIndent: boolean

Gibt zurück

void

setColumnWidth(columnWidth)

Gibt die Breite aller Spalten innerhalb des Bereichs an.

setColumnWidth(columnWidth: number): void;

Parameter

columnWidth: number

Gibt zurück

void

Beispiele

/**
 * This script inserts a new column and sets that column's width to 100 pixels wide.
 */
function main(workbook: ExcelScript.Workbook) {
  const currentSheet = workbook.getActiveWorksheet();

  // Insert a new column between the current B and C columns.
  const bcRange = currentSheet.getRange("C:C");
  const newColumn = bcRange.insert(ExcelScript.InsertShiftDirection.right);
  
  // Set the column width of the new column to 100 pixels.
  newColumn.getFormat().setColumnWidth(100);
}

setHorizontalAlignment(horizontalAlignment)

Stellt die horizontale Ausrichtung für das angegebene Objekt dar. Weitere Informationen finden Sie unter ExcelScript.HorizontalAlignment .

setHorizontalAlignment(horizontalAlignment: HorizontalAlignment): void;

Parameter

horizontalAlignment: ExcelScript.HorizontalAlignment

Gibt zurück

void

Beispiele

/**
 * This script centers the text in a table's header row cells.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first table on the current worksheet.
  const currentSheet = workbook.getActiveWorksheet();
  const table = currentSheet.getTables()[0];

  // Get the header range.
  const headerRange = table.getHeaderRowRange();

  // Set the horizontal text alignment to `center`.
  headerRange.getFormat().setHorizontalAlignment(ExcelScript.HorizontalAlignment.center);
}

setIndentLevel(indentLevel)

Eine ganze Zahl zwischen 0 und 250, die die Einzugsebene angibt.

setIndentLevel(indentLevel: number): void;

Parameter

indentLevel: number

Gibt zurück

void

setRangeBorderTintAndShade(rangeBorderTintAndShade)

setRangeBorderTintAndShade(rangeBorderTintAndShade: number): void;

Parameter

rangeBorderTintAndShade: number

Gibt zurück

void

setReadingOrder(readingOrder)

Die Leserichtung für den Bereich.

setReadingOrder(readingOrder: ReadingOrder): void;

Parameter

readingOrder: ExcelScript.ReadingOrder

Gibt zurück

void

setRowHeight(rowHeight)

Gibt die Höhe aller Zeilen im Bereich an.

setRowHeight(rowHeight: number): void;

Parameter

rowHeight: number

Gibt zurück

void

Beispiele

/**
 * This script inserts a new row and sets that row's width to 100 pixels tall.
 */
function main(workbook: ExcelScript.Workbook) {
  const currentSheet = workbook.getActiveWorksheet();

  // Insert a new row between the current 2 and 3 rows.
  const bcRange = currentSheet.getRange("3:3");
  const newRow = bcRange.insert(ExcelScript.InsertShiftDirection.down);
  
  // Set the row height of the new row to 100 pixels.
  newRow.getFormat().setRowHeight(100);
}

setShrinkToFit(shrinkToFit)

Gibt an, ob der Text automatisch verkleinert wird, um in die verfügbare Spaltenbreite einzupassen.

setShrinkToFit(shrinkToFit: boolean): void;

Parameter

shrinkToFit: boolean

Gibt zurück

void

setTextOrientation(textOrientation)

setTextOrientation(textOrientation: number): void;

Parameter

textOrientation: number

Gibt zurück

void

setUseStandardHeight(useStandardHeight)

Bestimmt, ob die Zeilenhöhe des Range Objekts der Standardhöhe des Blatts entspricht. Hinweis: Diese Eigenschaft soll nur auf truefestgelegt werden. Das Festlegen auf hat false keine Auswirkungen.

setUseStandardHeight(useStandardHeight: boolean): void;

Parameter

useStandardHeight: boolean

Gibt zurück

void

setUseStandardWidth(useStandardWidth)

Gibt an, ob die Spaltenbreite des Range Objekts der Standardbreite des Blatts entspricht. Hinweis: Diese Eigenschaft soll nur auf truefestgelegt werden. Das Festlegen auf hat false keine Auswirkungen.

setUseStandardWidth(useStandardWidth: boolean): void;

Parameter

useStandardWidth: boolean

Gibt zurück

void

setVerticalAlignment(verticalAlignment)

Stellt die vertikale Ausrichtung für das angegebene Objekt dar. Weitere Informationen finden Sie unter ExcelScript.VerticalAlignment .

setVerticalAlignment(verticalAlignment: VerticalAlignment): void;

Parameter

verticalAlignment: ExcelScript.VerticalAlignment

Gibt zurück

void

Beispiele

/**
 * This script sets the vertical alignment formatting to "top"
 * for every cell in the row.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get row 1 for the current worksheet.
  const sheet = workbook.getActiveWorksheet();
  const firstRow = sheet.getRange("1:1");

  // Set the vertical alignment formatting on the row.
  firstRow.getFormat().setVerticalAlignment(ExcelScript.VerticalAlignment.top);
}

setWrapText(wrapText)

Gibt an, ob Excel den Text im -Objekt umschließt. Ein null -Wert gibt an, dass der gesamte Bereich keine einheitliche Umbrucheinstellung aufweist.

setWrapText(wrapText: boolean): void;

Parameter

wrapText: boolean

Gibt zurück

void

Beispiele

/**
 * This script turns on the text wrapping for a column.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the E column in current worksheet.
  const column = workbook.getActiveWorksheet().getRange("E:E");

  // Set wrap text to true for the column.
  column.getFormat().setWrapText(true);
}