Excel.RangeFormat class
Gibt ein Formatobjekt zurück, das die Schriftart des Bereichs, Füllung, Rahmen, die Ausrichtung und andere Eigenschaften verschachtelt.
- Extends
Hinweise
Eigenschaften
| auto |
Gibt an, ob Text automatisch eingezogen wird, wenn die Textausrichtung auf die gleiche Verteilung festgelegt ist. |
| borders | Auflistung von Border-Objekten, die für den gesamten ausgewählten Bereich gelten. |
| column |
Gibt die Breite aller Spalten innerhalb des Bereichs an. Wenn die Spaltenbreiten nicht einheitlich sind, |
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| fill | Gibt das Fill-Objekt an, das für den gesamten Bereich definiert ist. |
| font | Gibt das Font-Objekt an, das für den gesamten Bereich definiert ist. |
| horizontal |
Stellt die horizontale Ausrichtung für das angegebene Objekt dar. Weitere Informationen finden Sie unter |
| indent |
Eine ganze Zahl zwischen 0 und 250, die die Einzugsebene angibt. |
| protection | Gibt das Formatschutz-Objekt für einen Bereich zurück. |
| reading |
Die Leserichtung für den Bereich. |
| row |
Die Höhe aller Zeilen im Bereich. Wenn die Zeilenhöhen nicht einheitlich sind, |
| shrink |
Gibt an, ob der Text automatisch verkleinert wird, um in die verfügbare Spaltenbreite einzupassen. |
| text |
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, |
| use |
Bestimmt, ob die Zeilenhöhe des |
| use |
Gibt an, ob die Spaltenbreite des |
| vertical |
Stellt die vertikale Ausrichtung für das angegebene Objekt dar. Weitere Informationen finden Sie unter |
| wrap |
Gibt an, ob Excel den Text im -Objekt umschließt. Ein |
Methoden
| adjust |
Passt den Einzug der Bereichsformatierung an. Der Einzugswert reicht von 0 bis 250 und wird in Zeichen gemessen. |
| autofit |
Ändert die Breite der Spalten des aktuellen Bereichs, um basierend auf den aktuellen Daten in den Spalten die optimale Breite zu erzielen. |
| autofit |
Ändert die Höhe der Zeilen des aktuellen Bereichs, um basierend auf den aktuellen Daten in den Zeilen die optimale Höhe zu erzielen. |
| load(options) | Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| set(properties, options) | Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben. |
| set(properties) | Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt. |
| toJSON() | Überschreibt die JavaScript-Methode |
Details zur Eigenschaft
autoIndent
Gibt an, ob Text automatisch eingezogen wird, wenn die Textausrichtung auf die gleiche Verteilung festgelegt ist.
autoIndent: boolean;Eigenschaftswert
boolean
Hinweise
borders
Auflistung von Border-Objekten, die für den gesamten ausgewählten Bereich gelten.
readonly borders: Excel.RangeBorderCollection;Eigenschaftswert
Hinweise
columnWidth
Gibt die Breite aller Spalten innerhalb des Bereichs an. Wenn die Spaltenbreiten nicht einheitlich sind, null wird zurückgegeben.
columnWidth: number;Eigenschaftswert
number
Hinweise
context
Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
fill
Gibt das Fill-Objekt an, das für den gesamten Bereich definiert ist.
readonly fill: Excel.RangeFill;Eigenschaftswert
Hinweise
font
Gibt das Font-Objekt an, das für den gesamten Bereich definiert ist.
readonly font: Excel.RangeFont;Eigenschaftswert
Hinweise
horizontalAlignment
Stellt die horizontale Ausrichtung für das angegebene Objekt dar. Weitere Informationen finden Sie unter Excel.HorizontalAlignment .
horizontalAlignment: Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed";Eigenschaftswert
Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed"
Hinweise
indentLevel
Eine ganze Zahl zwischen 0 und 250, die die Einzugsebene angibt.
indentLevel: number;Eigenschaftswert
number
Hinweise
protection
Gibt das Formatschutz-Objekt für einen Bereich zurück.
readonly protection: Excel.FormatProtection;Eigenschaftswert
Hinweise
readingOrder
Die Leserichtung für den Bereich.
readingOrder: Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft";Eigenschaftswert
Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft"
Hinweise
rowHeight
Die Höhe aller Zeilen im Bereich. Wenn die Zeilenhöhen nicht einheitlich sind, null wird zurückgegeben.
rowHeight: number;Eigenschaftswert
number
Hinweise
shrinkToFit
Gibt an, ob der Text automatisch verkleinert wird, um in die verfügbare Spaltenbreite einzupassen.
shrinkToFit: boolean;Eigenschaftswert
boolean
Hinweise
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.
textOrientation: number;Eigenschaftswert
number
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-text-orientation.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const range = sheet.getRange("B2:E2");
// Set textOrientation to either an integer between -90 and 90
// or to 180 for vertically-oriented text.
range.format.textOrientation = 90;
await context.sync();
});
useStandardHeight
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 . Hinweis: Diese Eigenschaft soll nur auf truefestgelegt werden. Das Festlegen auf hat false keine Auswirkungen.
useStandardHeight: boolean;Eigenschaftswert
boolean
Hinweise
useStandardWidth
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 . Hinweis: Diese Eigenschaft soll nur auf truefestgelegt werden. Das Festlegen auf hat false keine Auswirkungen.
useStandardWidth: boolean;Eigenschaftswert
boolean
Hinweise
verticalAlignment
Stellt die vertikale Ausrichtung für das angegebene Objekt dar. Weitere Informationen finden Sie unter Excel.VerticalAlignment .
verticalAlignment: Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed";Eigenschaftswert
Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed"
Hinweise
wrapText
Gibt an, ob Excel den Text im -Objekt umschließt. Ein null -Wert gibt an, dass der gesamte Bereich keine einheitliche Umbrucheinstellung aufweist.
wrapText: boolean;Eigenschaftswert
boolean
Hinweise
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
Hinweise
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
Hinweise
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
Hinweise
load(options)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(options?: Excel.Interfaces.RangeFormatLoadOptions): Excel.RangeFormat;Parameter
Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.
Gibt zurück
load(propertyNames)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNames?: string | string[]): Excel.RangeFormat;Parameter
- propertyNames
-
string | string[]
Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.
Gibt zurück
Beispiele
// Select all of the range's format properties.
await Excel.run(async (context) => {
const sheetName = "Sheet1";
const rangeAddress = "F:G";
const worksheet = context.workbook.worksheets.getItem(sheetName);
const range = worksheet.getRange(rangeAddress);
range.load(["format/*", "format/fill", "format/borders", "format/font"]);
await context.sync();
console.log(range.format.wrapText);
console.log(range.format.fill.color);
console.log(range.format.font.name);
});
load(propertyNamesAndPaths)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.RangeFormat;Parameter
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
set(properties, options)
Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.
set(properties: Interfaces.RangeFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameter
- properties
- Excel.Interfaces.RangeFormatUpdateData
Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.
- options
- OfficeExtension.UpdateOptions
Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt versucht, schreibgeschützte Eigenschaften festzulegen.
Gibt zurück
void
set(properties)
Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.
set(properties: Excel.RangeFormat): void;Parameter
- properties
- Excel.RangeFormat
Gibt zurück
void
toJSON()
Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Excel.RangeFormat-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.RangeFormatData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): Excel.Interfaces.RangeFormatData;Gibt zurück
Office Add-ins
Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.
Feedback senden und anzeigen für