Excel.RangeFormat class

一个格式对象,其中封装了区域的字体、填充、边框、对齐方式和其他属性。

扩展

注解

[ API 集:ExcelApi 1.1 ]

属性

autoIndent

指定当文本对齐方式设置为相等分布时,是否自动缩进文本。

borders

应用于整个区域的 Border 对象的集合。

columnWidth

指定范围内所有列的宽度。 如果列宽不一致, null 将返回 。

context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

fill

返回在整个区域内定义的 fill 对象。

font

返回在整个区域内定义的 Font 对象。

horizontalAlignment

表示指定对象的水平对齐方式。 有关详细信息,请参阅 Excel.HorizontalAlignment

indentLevel

0 到 250 之间的一个整数,指示缩进水平。

protection

返回某一区域的格式 protection 对象。

readingOrder

区域的读取顺序。

rowHeight

范围中所有行的高度。 如果行高度不一致, null 将返回 。

shrinkToFit

指定文本是否自动收缩以适应可用的列宽。

textOrientation

区域中所有单元格的文本方向。 对于垂直方向文本,文本方向应为 -90 到 90 或 180 的整数。 如果范围内的方向不一致,则会 null 返回 。

useStandardHeight

确定对象的行高 Range 是否等于工作表的标准高度。 true如果 对象的行高度Range等于工作表的标准高度,则返回 。 null如果区域包含多行且行的高度不相同,则返回 。 否则返回 false 。 注意:此属性仅用于设置为 true。 将其设置为 false 不起作用。

useStandardWidth

指定 对象的列宽 Range 是否等于工作表的标准宽度。 true如果 对象的列宽Range等于工作表的标准宽度,则返回 。 null如果区域包含多个列且各列的高度不同,则返回 。 否则返回 false 。 注意:此属性仅用于设置为 true。 将其设置为 false 不起作用。

verticalAlignment

表示指定对象的垂直对齐方式。 有关详细信息,请参阅 Excel.VerticalAlignment

wrapText

指定 Excel 是否包装对象中的文本。 值 null 指示整个区域没有统一换行设置

方法

adjustIndent(amount)

调整区域格式的缩进。 缩进值范围为 0 到 250,以字符为单位。

autofitColumns()

根据列中的当前数据更改当前范围的列宽,以达到最佳宽度。

autofitRows()

根据列中的当前数据,更改当前范围的行高以达到最佳高度。

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

set(properties, options)

同时设置对象的多个属性。 可以传递具有相应属性的纯对象,也可以传递同一类型的另一个 API 对象。

set(properties)

基于现有的已加载对象,同时对对象设置多个属性。

toJSON()

重写 JavaScript toJSON() 方法,以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (,反过来又调用toJSON传递给它的 对象的 方法。) 而原始Excel.RangeFormat对象是 API 对象,toJSON该方法返回一个纯 JavaScript 对象, (类型为 Excel.Interfaces.RangeFormatData) ,其中包含原始对象中任何已加载子属性的浅表副本。

属性详细信息

autoIndent

指定当文本对齐方式设置为相等分布时,是否自动缩进文本。

autoIndent: boolean;

属性值

boolean

注解

[ API 集:ExcelApi 1.9 ]

borders

应用于整个区域的 Border 对象的集合。

readonly borders: Excel.RangeBorderCollection;

属性值

注解

[ API 集:ExcelApi 1.1 ]

columnWidth

指定范围内所有列的宽度。 如果列宽不一致, null 将返回 。

columnWidth: number;

属性值

number

注解

[ API 集:ExcelApi 1.2 ]

context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

fill

返回在整个区域内定义的 fill 对象。

readonly fill: Excel.RangeFill;

属性值

注解

[ API 集:ExcelApi 1.1 ]

font

返回在整个区域内定义的 Font 对象。

readonly font: Excel.RangeFont;

属性值

注解

[ API 集:ExcelApi 1.1 ]

horizontalAlignment

表示指定对象的水平对齐方式。 有关详细信息,请参阅 Excel.HorizontalAlignment

horizontalAlignment: Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed";

属性值

Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed"

注解

[ API 集:ExcelApi 1.1 ]

indentLevel

0 到 250 之间的一个整数,指示缩进水平。

indentLevel: number;

属性值

number

注解

[ API 集:ExcelApi 1.9 ]

protection

返回某一区域的格式 protection 对象。

readonly protection: Excel.FormatProtection;

属性值

注解

[ API 集:ExcelApi 1.2 ]

readingOrder

区域的读取顺序。

readingOrder: Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft";

属性值

Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft"

注解

[ API 集:ExcelApi 1.9 ]

rowHeight

范围中所有行的高度。 如果行高度不一致, null 将返回 。

rowHeight: number;

属性值

number

注解

[ API 集:ExcelApi 1.2 ]

shrinkToFit

指定文本是否自动收缩以适应可用的列宽。

shrinkToFit: boolean;

属性值

boolean

注解

[ API 集:ExcelApi 1.9 ]

textOrientation

区域中所有单元格的文本方向。 对于垂直方向文本,文本方向应为 -90 到 90 或 180 的整数。 如果范围内的方向不一致,则会 null 返回 。

textOrientation: number;

属性值

number

注解

[ API 集:ExcelApi 1.7 ]

示例

// 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

确定对象的行高 Range 是否等于工作表的标准高度。 true如果 对象的行高度Range等于工作表的标准高度,则返回 。 null如果区域包含多行且行的高度不相同,则返回 。 否则返回 false 。 注意:此属性仅用于设置为 true。 将其设置为 false 不起作用。

useStandardHeight: boolean;

属性值

boolean

注解

[ API 集:ExcelApi 1.7 ]

useStandardWidth

指定 对象的列宽 Range 是否等于工作表的标准宽度。 true如果 对象的列宽Range等于工作表的标准宽度,则返回 。 null如果区域包含多个列且各列的高度不同,则返回 。 否则返回 false 。 注意:此属性仅用于设置为 true。 将其设置为 false 不起作用。

useStandardWidth: boolean;

属性值

boolean

注解

[ API 集:ExcelApi 1.7 ]

verticalAlignment

表示指定对象的垂直对齐方式。 有关详细信息,请参阅 Excel.VerticalAlignment

verticalAlignment: Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed";

属性值

Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed"

注解

[ API 集:ExcelApi 1.1 ]

wrapText

指定 Excel 是否包装对象中的文本。 值 null 指示整个区域没有统一换行设置

wrapText: boolean;

属性值

boolean

注解

[ API 集:ExcelApi 1.1 ]

方法详细信息

adjustIndent(amount)

调整区域格式的缩进。 缩进值范围为 0 到 250,以字符为单位。

adjustIndent(amount: number): void;

参数

amount

number

调整当前缩进所依据的字符空格数。 此值应介于 -250 和 250 之间。 注意:如果金额将缩进级别提高到 250 以上,缩进级别将保持 250。 同样,如果量将缩进级别降低到 0 以下,缩进级别将保持 0。

返回

void

注解

[ API 集:ExcelApi 1.11 ]

autofitColumns()

根据列中的当前数据更改当前范围的列宽,以达到最佳宽度。

autofitColumns(): void;

返回

void

注解

[ API 集:ExcelApi 1.2 ]

autofitRows()

根据列中的当前数据,更改当前范围的行高以达到最佳高度。

autofitRows(): void;

返回

void

注解

[ API 集:ExcelApi 1.2 ]

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

load(options?: Excel.Interfaces.RangeFormatLoadOptions): Excel.RangeFormat;

参数

options
Excel.Interfaces.RangeFormatLoadOptions

提供要加载对象的属性的选项。

返回

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

load(propertyNames?: string | string[]): Excel.RangeFormat;

参数

propertyNames

string | string[]

逗号分隔的字符串或指定要加载的属性的字符串数组。

返回

示例

// 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)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.RangeFormat;

参数

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select 是一个逗号分隔的字符串,指定要加载的属性,是 propertyNamesAndPaths.expand 一个逗号分隔的字符串,指定要加载的导航属性。

返回

set(properties, options)

同时设置对象的多个属性。 可以传递具有相应属性的纯对象,也可以传递同一类型的另一个 API 对象。

set(properties: Interfaces.RangeFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;

参数

properties
Excel.Interfaces.RangeFormatUpdateData

一个 JavaScript 对象,其属性按同构方式构造为调用方法的对象的属性。

options
OfficeExtension.UpdateOptions

提供一个选项,用于在 properties 对象尝试设置任何只读属性时禁止显示错误。

返回

void

set(properties)

基于现有的已加载对象,同时对对象设置多个属性。

set(properties: Excel.RangeFormat): void;

参数

properties
Excel.RangeFormat

返回

void

toJSON()

重写 JavaScript toJSON() 方法,以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (,反过来又调用toJSON传递给它的 对象的 方法。) 而原始Excel.RangeFormat对象是 API 对象,toJSON该方法返回一个纯 JavaScript 对象, (类型为 Excel.Interfaces.RangeFormatData) ,其中包含原始对象中任何已加载子属性的浅表副本。

toJSON(): Excel.Interfaces.RangeFormatData;

返回