playbook/skills/tsl-api-reference/references/codegen/dotnet/document/office_class.md

文档处理 / Office操作相关的类

addSeries(name, categories, value)

声明：function

添加图表Series数据

参数	类型	说明
name	string	string 系列名称范围
categories	string	string 数据标签范围
value	string	string 值域范围

返回：int

addText(s)

声明：function

设置文本。

参数	类型	说明
s	string	字符串，设置文本

返回：class

alignment()

声明：function

对齐样式，设置TAlignment对齐样式类中的属性。TAlignment的属性具体可参考TAlignment 类型：写

返回：any

alignWithMargin()

声明：function

是否与页边距对齐 类型：写

返回：any

application()

声明：function

应用程序 类型：写

返回：any

apply()

声明：function

更新图表

返回：any

appVersion()

声明：function

更新超应用程序版本。 类型：写

返回：any

backgroundColor()

声明：function

背景色-RGB颜色，注：BackgroundColor和BackgroundThemeColor只能设置一种 类型：写

返回：any

backgroundThemeColor()

声明：function

背景色-主题颜色，注：BackgroundColor和BackgroundThemeColor只能设置一种 类型：写

返回：any

backgroundThemeColorTint()

声明：function

背景色-主题颜色的色调。 类型：写

返回：any

begColOff()

声明：function

开始列偏移 类型：写

返回：any

begRowOff()

声明：function

开始行偏移 类型：写

返回：any

blackAndWhite()

声明：function

单色打印。 类型：写

返回：any

bold()

声明：function

是否加粗，默认False。 类型：写

返回：any

border()

声明：function

边框样式，设置TBorders边框样式类中的属性。TBorders的属性具体可参考TBorders 类型：写

返回：any

bottom()

声明：function

下边框。设置下边框的Tborder属性，具体Tborder参看：Tborder 类型：写

返回：any

cellComments()

声明：function

注释。 取值 含义 nil（默认） 无 "atEnd" 工作表末尾 "asDisplayed" 如同工作表中的显示 类型：写

返回：any

cellError()

声明：function

错误单元格打印为 取值 含义 nil（默认） 显示值 "blank" 空白 "dash" "--" 类型：写

返回：any

charset()

声明：function

字符集。 类型：写

返回：any

clearSeries()

声明：function

清除图表Series数据

返回：any

color()

声明：function

RGB颜色，如"A020F0"。 注：Color和ThemeColor只能设置一种 类型：写

返回：any

color1()

声明：function

渐变的第一种颜色-RGB颜色，如"A020F0"。 注：Color1和ThemeColor1只能设置一种 类型：写

返回：any

color2()

声明：function

渐变的第二种颜色-RGB颜色，如"A020F0"。 注：Color2和ThemeColor2只能设置一种 类型：写

返回：any

creator()

声明：function

作者 类型：写

返回：any

dataTable()

声明：function

显示数据表 类型：读/写

返回：any

descr()

声明：function

图片描述 类型：写

返回：any

diagonal()

声明：function

对角线。设置对角线的Tborder属性，具体Tborder参看：Tborder，在设置DiagonalUp或DiagonalDown时有效 类型：写

返回：any

diagonalDown()

声明：function

左上-右下 对角线 类型：写

返回：any

diagonalUp()

声明：function

左下-右上 对角线 类型：写

返回：any

differentFirst()

声明：function

是否单独设定首页页眉页脚 类型：写

返回：any

differentOddEven()

声明：function

是否分别设定奇数和偶数页页眉和页脚，若为FALSE（默认）时，仅需设置OddHeader和OddFooter 类型：写

返回：any

display()

声明：function

超链接悬浮提示内容 类型：写

返回：any

docSecurity()

声明：function

文件安全 类型：写

返回：any

draft()

声明：function

是否开启草稿质量。 类型：写

返回：any

endColOff()

声明：function

结束列偏移 类型：写

返回：any

endRowOff()

声明：function

结束行偏移 类型：写

返回：any

evenFooter()

声明：function

偶数页页脚控制符，仅DifferentOddEven= TRUE 时有效 类型：写

返回：any

evenHeader()

声明：function

偶数页页眉控制符，仅DifferentOddEven= TRUE 时有效 类型：写

返回：any

fill()

声明：function

填充样式，设置TFills填充样式类中的属性。TFills的属性具体可参考TFills 类型：写

返回：any

firstFooter()

声明：function

首页页脚控制符，仅DifferentFirst= TRUE 时有效 类型：写

返回：any

firstHeader()

声明：function

首页页眉控制符，仅DifferentFirst= TRUE 时有效 类型：写

返回：any

firstPageNumber()

声明：function

起始页码 类型：写

返回：any

fitToHeight()

声明：function

页高，注：Scale和FitToWidth,FitToHeight只能设置一种 类型：写

返回：any

fitToWidth()

声明：function

页宽，注：Scale和FitToWidth,FitToHeight只能设置一种 类型：写

返回：any

font()

声明：function

字体样式，设置TFont字体样式类中的属性。TFont的属性具体可参考TFont 类型：写

返回：any

footer()

声明：function

页脚页边距 类型：写

返回：any

foregroundColor()

声明：function

前景色-RGB颜色，注：ForegroundColor和ForegroundThemeColor只能设置一种 类型：写

返回：any

foregroundThemeColor()

声明：function

前景色-主题颜色，注：ForegroundColor和ForegroundThemeColor只能设置一种 类型：写

返回：any

foregroundThemeColorTint()

声明：function

前景色-主题颜色的色调。 类型：写

返回：any

formatCode()

声明：function

数字格式。 类型：写

返回：any

gradient()

声明：function

颜色渐变填充。设置TGradient颜色渐变类的属性，具体参看：TGradient。注：Pattern和Gradient只能设置一种 类型：写

返回：any

header()

声明：function

页眉页边距 类型：写

返回：any

height()

声明：function

图表高度（cm） 类型：读/写

返回：any

hide()

声明：function

隐藏 类型：写

返回：any

horizontal()

声明：function

水平对齐。 取值 含义 nil(默认) 靠右 "center" 居中 "left" 靠左 "fill" 填充 "justify" 两端对齐 "distributed" 分散对齐 "centerContinuous" 跨列居中 类型：写

返回：any

hyperlinkBase()

声明：function

超链接基础 类型：写

返回：any

hyperlinksChanged()

声明：function

更新超链接，"false"（默认），"true" 类型：写

返回：any

image()

声明：function

图片的二进制数据 类型：写

返回：any

italic()

声明：function

是否倾斜，默认False。 类型：写

返回：any

left()

声明：function

左边框。设置左边框的Tborder属性，具体Tborder参看：Tborder 类型：写

返回：any

lineStyle()

声明：function

线型。取值有"hair"，"dotted"，"dashDotDot"，"dashDot"，"dashed"，"thin"，"slantDashDot"，"mediumDashedDotDot"，"mediumDashedDot"，"mediumDashed"，"medium"，"thick"，"double" 类型：写

返回：any

linksUpToDate()

声明：function

最新链接，"false"（默认），"true" 类型：写

返回：any

linkType()

声明：function

超链接类型。"External": 外部超链接 类型：写

返回：any

linkUrl()

声明：function

超链接地址 类型：写

返回：any

lock()

声明：function

锁定 类型：写

返回：any

manager()

声明：function

经理 类型：写

返回：any

oddFooter()

声明：function

奇数页页脚控制符 类型：写

返回：any

oddHeader()

声明：function

奇数页页眉控制符 类型：写

返回：any

orientation()

声明：function

纸张方向。 取值 含义 "landscape" 横向 "portrait" 纵向 类型：写

返回：any

pageOrder()

声明：function

打印顺序 取值 含义 nil（默认） 先列后行 "overThenDown" 先行后列 类型：写

返回：any

paperSize()

声明：function

纸张大小 类型：写

返回：any

pattern()

声明：function

图案填充。设置TPattern图案填充类的属性，具体参看：TPattern。注：Pattern和Gradient只能设置一种 类型：写

返回：any

patternType()

声明：function

图案样式 类型：写

返回：any

readingOrder()

声明：function

文字方向。 取值 含义 nil(默认) 根据内容 1 总是从左到右 2 总是从右到左 类型：写

返回：any

removeSeries(i)

声明：function

删除图表Series数据

参数	类型	说明
i	any	int Series数据标签

返回：any

right()

声明：function

右边框。设置右边框的Tborder属性，具体Tborder参看：Tborder 类型：写

返回：any

scale()

声明：function

缩放比例(%)，注：Scale和FitToWidth,FitToHeight只能设置一种 类型：写

返回：any

scaleCrop()

声明：function

缩略图，"false"（默认），"true" 类型：写

返回：any

scaleWithDoc()

声明：function

是否随文档一起缩放 类型：写

返回：any

script()

声明：function

上下标， 取值 含义 "subscript" 下标 "superscript" 上标 类型：写

返回：any

shading()

声明：function

底纹样式。 取值 含义 0 水平渐变，颜色1从上到下渐变到颜色2 1 水平渐变，颜色2从上到下渐变到颜色1 2 水平渐变，三层颜色，颜色1从上渐变到中间颜色2，再从颜色2渐变到底部颜色1 3 垂直渐变，颜色1从左到右渐变到颜色2 4 垂直渐变，颜色2从右到左渐变到颜色1 5 垂直渐变，三层颜色，颜色1从左渐变到中间颜色2，再从颜色2渐变到右边颜色1 6 斜上渐变，颜色1左上渐变到右下颜色2 7 斜上渐变，颜色2左上渐变到右下颜色1 8 斜上渐变，三层颜色，颜色1从左上渐变到对角线颜色2，再从颜色2渐变到右下颜色1 9 斜下渐变，颜色1右上渐变到左下颜色2 10 斜下渐变，颜色2左上渐变到右下颜色1 11 斜下渐变，三层颜色，颜色1从左上渐变到对角线颜色2，再从颜色2渐变到右下颜色1 12 角部辐射渐变，颜色1左上角辐射渐变到右下角2 13 角部辐射渐变，颜色1右上角辐射渐变到左下角颜色2 14 角部辐射渐变，颜色1左下角辐射渐变到右上角2 15 角部辐射渐变，颜色1右下角辐射渐变到左上角颜色2 16 中心辐射渐变，颜色1从中心向四周辐射到颜色2 类型：写

返回：any

sharedDoc()

声明：function

共享文档，"false"（默认），"true" 类型：写

返回：any

showBlanksAs()

声明：function

指定如何在图表上绘制空白单元格 类型：读/写

返回：any

showBubbleSize()

声明：function

允许用户在图表中显示数据标签的气泡大小 类型：读/写

返回：any

showCatName()

声明：function

允许用户在图表中显示数据标签的分类名称 类型：读/写

返回：string

showDataTable(b)

声明：function

在图形中是否展示数据表格

参数	类型	说明
b	bool	object

返回：any

showFirstColumn()

声明：function

第一列 类型：写

返回：any

showLastColumn()

声明：function

最后一列 类型：写

返回：any

showLeaderLines()

声明：function

如果数据系列有引导线，则该属性值为 True 类型：读/写

返回：any

showLegendKey()

声明：function

如果数据标签的图例项标示可见，则该属性值为 True 类型：读/写

返回：any

showPercent()

声明：function

允许用户在图表中显示数据标签的百分比数值 类型：读/写

返回：any

showRowStripes()

声明：function

镶边行 类型：写

返回：any

showSerName()

声明：function

允许用户在图表中显示数据标签的系列名称 类型：读/写

返回：string

showVal()

声明：function

允许用户在图表中显示数据标签的值 类型：读/写

返回：any

size()

声明：function

字体大小。 类型：写

返回：any

strikethrough()

声明：function

是否启用删除线，默认False。 类型：写

返回：any

subject()

声明：function

主题 类型：写

返回：any

tableName()

声明：function

表名 类型：写

返回：string

tableStyle()

声明：function

表格样式 类型：写

返回：any

themeColor()

声明：function

主题颜色。 注：Color和ThemeColor只能设置一种 类型：写

返回：any

themeColor1()

声明：function

渐变的第一种颜色-主题颜色。 注：Color1和ThemeColor1只能设置一种 类型：写

返回：any

themeColor2()

声明：function

渐变的第二种颜色-主题颜色。 注：Color2和ThemeColor2只能设置一种 类型：写

返回：any

title()

声明：function

图表标题 类型：读/写

返回：any

tooltip()

声明：function

单元格显示的内容 类型：写

返回：any

top()

声明：function

上边框。设置上边框的Tborder属性，具体Tborder参看：Tborder 类型：写

返回：any

type()

声明：function

图表类型 类型：读/写

返回：any

underline()

声明：function

下划线 取值 含义 "double" 双下划线 "singleAccounting" 会计单下划线 "doubleAccounting" 会计双下划线 类型：写

返回：any

updateTitle(t)

声明：function

修改图表标题

参数	类型	说明
t	string	string 图表名称

返回：any

varyColors()

声明：function

varyColors (按点) 改变颜色，此元素指定系列中的每个数据标记具有不同的颜色。 类型：读/写

返回：any

vertical()

声明：function

垂直对齐。 取值 含义 nil(默认) 靠右 "center" 居中 "top" 靠上 "justify" 两端对齐 "distributed" 分散对齐 类型：写

返回：any

width()

声明：function

图表宽度（cm） 类型：读/写

返回：any