ExcelScript.RangeFormat interface

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

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 eine 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 ExcelScript.HorizontalAlignment unter.

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 einen Double-Wert an, der eine Farbe für Bereichsrahmen aufhellt oder abdunkelt. Der Wert liegt zwischen -1 (dunkelster) und 1 (hellster), mit 0 für die Originalfarbe. Ein null Wert gibt an, dass die gesamte Rahmensammlung 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 Text automatisch so verkleinert wird, dass er in die verfügbare Spaltenbreite passt.

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 sie zurückgegeben.

getUseStandardHeight()

Bestimmt, ob die Zeilenhöhe des Range Objekts der Standardhöhe des Blatts entspricht. Gibt true zurück, ob die Zeilenhöhe des Range Objekts der Standardhöhe des Blatts entspricht. Gibt null zurück, wenn der Bereich mehr als eine Zeile enthält und die Zeilen nicht alle dieselbe Höhe aufweisen. Gibt false andernfalls zurück. Hinweis: Diese Eigenschaft ist nur für die Festlegung auf true. Das Festlegen hat false keine Auswirkung.

getUseStandardWidth()

Gibt an, ob die Spaltenbreite des Range Objekts der Standardbreite des Blatts entspricht. Gibt true zurück, ob die Spaltenbreite des Range Objekts der Standardbreite des Blatts entspricht. Gibt null zurück, wenn der Bereich mehr als eine Spalte enthält und die Spalten nicht alle die gleiche Höhe haben. Gibt false andernfalls zurück. Hinweis: Diese Eigenschaft ist nur für die Festlegung auf true. Das Festlegen hat false keine Auswirkung.

getVerticalAlignment()

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

getWrapText()

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

setAutoIndent(autoIndent)

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

setColumnWidth(columnWidth)

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

setHorizontalAlignment(horizontalAlignment)

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

setIndentLevel(indentLevel)

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

setRangeBorderTintAndShade(rangeBorderTintAndShade)

Gibt einen Double-Wert an, der eine Farbe für Bereichsrahmen aufhellt oder abdunkelt. Der Wert liegt zwischen -1 (dunkelster) und 1 (hellster), mit 0 für die Originalfarbe. Ein null Wert gibt an, dass die gesamte Rahmensammlung keine einheitliche tintAndShade Einstellung aufweist.

setReadingOrder(readingOrder)

Die Leserichtung für den Bereich.

setRowHeight(rowHeight)

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

setShrinkToFit(shrinkToFit)

Gibt an, ob Text automatisch so verkleinert wird, dass er in die verfügbare Spaltenbreite passt.

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 sie zurückgegeben.

setUseStandardHeight(useStandardHeight)

Bestimmt, ob die Zeilenhöhe des Range Objekts der Standardhöhe des Blatts entspricht. Gibt true zurück, ob die Zeilenhöhe des Range Objekts der Standardhöhe des Blatts entspricht. Gibt null zurück, wenn der Bereich mehr als eine Zeile enthält und die Zeilen nicht alle dieselbe Höhe aufweisen. Gibt false andernfalls zurück. Hinweis: Diese Eigenschaft ist nur für die Festlegung auf true. Das Festlegen hat false keine Auswirkung.

setUseStandardWidth(useStandardWidth)

Gibt an, ob die Spaltenbreite des Range Objekts der Standardbreite des Blatts entspricht. Gibt true zurück, ob die Spaltenbreite des Range Objekts der Standardbreite des Blatts entspricht. Gibt null zurück, wenn der Bereich mehr als eine Spalte enthält und die Spalten nicht alle die gleiche Höhe haben. Gibt false andernfalls zurück. Hinweis: Diese Eigenschaft ist nur für die Festlegung auf true. Das Festlegen hat false keine Auswirkung.

setVerticalAlignment(verticalAlignment)

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

setWrapText(wrapText)

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

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 Zeichenplätze, 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

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

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

getAutoIndent()

Gibt an, ob Text automatisch eingezogen wird, wenn die Textausrichtung auf eine 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

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

getFill()

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

getFill(): RangeFill;

Gibt zurück

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

getHorizontalAlignment()

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

getHorizontalAlignment(): HorizontalAlignment;

Gibt zurück

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

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 ExcelScript.BorderIndex unter.

Gibt zurück

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 einen Double-Wert an, der eine Farbe für Bereichsrahmen aufhellt oder abdunkelt. Der Wert liegt zwischen -1 (dunkelster) und 1 (hellster), mit 0 für die Originalfarbe. Ein null Wert gibt an, dass die gesamte Rahmensammlung keine einheitliche tintAndShade Einstellung aufweist.

getRangeBorderTintAndShade(): number;

Gibt zurück

number

getReadingOrder()

Die Leserichtung für den Bereich.

getReadingOrder(): ReadingOrder;

Gibt zurück

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

getShrinkToFit()

Gibt an, ob Text automatisch so verkleinert wird, dass er in die verfügbare Spaltenbreite passt.

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 sie zurückgegeben.

getTextOrientation(): number;

Gibt zurück

number

getUseStandardHeight()

Bestimmt, ob die Zeilenhöhe des Range Objekts der Standardhöhe des Blatts entspricht. Gibt true zurück, ob die Zeilenhöhe des Range Objekts der Standardhöhe des Blatts entspricht. Gibt null zurück, wenn der Bereich mehr als eine Zeile enthält und die Zeilen nicht alle dieselbe Höhe aufweisen. Gibt false andernfalls zurück. Hinweis: Diese Eigenschaft ist nur für die Festlegung auf true. Das Festlegen hat false keine Auswirkung.

getUseStandardHeight(): boolean;

Gibt zurück

boolean

getUseStandardWidth()

Gibt an, ob die Spaltenbreite des Range Objekts der Standardbreite des Blatts entspricht. Gibt true zurück, ob die Spaltenbreite des Range Objekts der Standardbreite des Blatts entspricht. Gibt null zurück, wenn der Bereich mehr als eine Spalte enthält und die Spalten nicht alle die gleiche Höhe haben. Gibt false andernfalls zurück. Hinweis: Diese Eigenschaft ist nur für die Festlegung auf true. Das Festlegen hat false keine Auswirkung.

getUseStandardWidth(): boolean;

Gibt zurück

boolean

getVerticalAlignment()

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

getVerticalAlignment(): VerticalAlignment;

Gibt zurück

getWrapText()

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

getWrapText(): boolean;

Gibt zurück

boolean

setAutoIndent(autoIndent)

Gibt an, ob Text automatisch eingezogen wird, wenn die Textausrichtung auf eine 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. Wenn die Spaltenbreiten nicht einheitlich sind, null wird zurückgegeben.

setColumnWidth(columnWidth: number): void;

Parameter

columnWidth

number

Gibt zurück

void

setHorizontalAlignment(horizontalAlignment)

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

setHorizontalAlignment(horizontalAlignment: HorizontalAlignment): void;

Parameter

horizontalAlignment
ExcelScript.HorizontalAlignment

Gibt zurück

void

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)

Gibt einen Double-Wert an, der eine Farbe für Bereichsrahmen aufhellt oder abdunkelt. Der Wert liegt zwischen -1 (dunkelster) und 1 (hellster), mit 0 für die Originalfarbe. Ein null Wert gibt an, dass die gesamte Rahmensammlung keine einheitliche tintAndShade Einstellung aufweist.

setRangeBorderTintAndShade(rangeBorderTintAndShade: number): void;

Parameter

rangeBorderTintAndShade

number

Gibt zurück

void

setReadingOrder(readingOrder)

Die Leserichtung für den Bereich.

setReadingOrder(readingOrder: ReadingOrder): void;

Parameter

Gibt zurück

void

setRowHeight(rowHeight)

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

setRowHeight(rowHeight: number): void;

Parameter

rowHeight

number

Gibt zurück

void

setShrinkToFit(shrinkToFit)

Gibt an, ob Text automatisch so verkleinert wird, dass er in die verfügbare Spaltenbreite passt.

setShrinkToFit(shrinkToFit: boolean): void;

Parameter

shrinkToFit

boolean

Gibt zurück

void

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 sie zurückgegeben.

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. Gibt true zurück, ob die Zeilenhöhe des Range Objekts der Standardhöhe des Blatts entspricht. Gibt null zurück, wenn der Bereich mehr als eine Zeile enthält und die Zeilen nicht alle dieselbe Höhe aufweisen. Gibt false andernfalls zurück. Hinweis: Diese Eigenschaft ist nur für die Festlegung auf true. Das Festlegen hat false keine Auswirkung.

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. Gibt true zurück, ob die Spaltenbreite des Range Objekts der Standardbreite des Blatts entspricht. Gibt null zurück, wenn der Bereich mehr als eine Spalte enthält und die Spalten nicht alle die gleiche Höhe haben. Gibt false andernfalls zurück. Hinweis: Diese Eigenschaft ist nur für die Festlegung auf true. Das Festlegen hat false keine Auswirkung.

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 ExcelScript.VerticalAlignment unter.

setVerticalAlignment(verticalAlignment: VerticalAlignment): void;

Parameter

verticalAlignment
ExcelScript.VerticalAlignment

Gibt zurück

void

setWrapText(wrapText)

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

setWrapText(wrapText: boolean): void;

Parameter

wrapText

boolean

Gibt zurück

void