Files
playbook/skills/tsl-api-reference/references/codegen/dotnet/document/office_class.md
T
csh e1f7ce052c feat(skills): add tsl api reference skill
Bundle the TSL API index and markdown references under the skill, route TSL docs to use it, and update the codegen index generator to maintain the bundled data.
2026-07-07 16:36:15 +08:00

12 KiB
Raw Blame History

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

addSeries(name, categories, value)

添加图表Series数据

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

返回:int

addText(s)

设置文本。

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

返回:class

alignment()

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

返回:any

alignWithMargin()

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

返回:any

application()

应用程序 类型:写

返回:any

apply()

更新图表

返回:any

appVersion()

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

返回:any

backgroundColor()

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

返回:any

backgroundThemeColor()

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

返回:any

backgroundThemeColorTint()

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

返回:any

begColOff()

开始列偏移 类型:写

返回:any

begRowOff()

开始行偏移 类型:写

返回:any

blackAndWhite()

单色打印。 类型:写

返回:any

bold()

是否加粗,默认False。 类型:写

返回:any

border()

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

返回:any

bottom()

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

返回:any

cellComments()

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

返回:any

cellError()

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

返回:any

charset()

字符集。 类型:写

返回:any

clearSeries()

清除图表Series数据

返回:any

color()

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

返回:any

color1()

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

返回:any

color2()

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

返回:any

creator()

作者 类型:写

返回:any

dataTable()

显示数据表 类型:读/写

返回:any

descr()

图片描述 类型:写

返回:any

diagonal()

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

返回:any

diagonalDown()

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

返回:any

diagonalUp()

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

返回:any

differentFirst()

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

返回:any

differentOddEven()

是否分别设定奇数和偶数页页眉和页脚,若为FALSE(默认)时,仅需设置OddHeader和OddFooter 类型:写

返回:any

display()

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

返回:any

docSecurity()

文件安全 类型:写

返回:any

draft()

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

返回:any

endColOff()

结束列偏移 类型:写

返回:any

endRowOff()

结束行偏移 类型:写

返回:any

evenFooter()

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

返回:any

evenHeader()

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

返回:any

fill()

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

返回:any

firstFooter()

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

返回:any

firstHeader()

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

返回:any

firstPageNumber()

起始页码 类型:写

返回:any

fitToHeight()

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

返回:any

fitToWidth()

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

返回:any

font()

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

返回:any

页脚页边距 类型:写

返回:any

foregroundColor()

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

返回:any

foregroundThemeColor()

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

返回:any

foregroundThemeColorTint()

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

返回:any

formatCode()

数字格式。 类型:写

返回:any

gradient()

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

返回:any

header()

页眉页边距 类型:写

返回:any

height()

图表高度(cm 类型:读/写

返回:any

hide()

隐藏 类型:写

返回:any

horizontal()

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

返回:any

hyperlinkBase()

超链接基础 类型:写

返回:any

hyperlinksChanged()

更新超链接,"false"(默认),"true" 类型:写

返回:any

image()

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

返回:any

italic()

是否倾斜,默认False。 类型:写

返回:any

left()

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

返回:any

lineStyle()

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

返回:any

linksUpToDate()

最新链接,"false"(默认),"true" 类型:写

返回:any

linkType()

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

返回:any

linkUrl()

超链接地址 类型:写

返回:any

lock()

锁定 类型:写

返回:any

manager()

经理 类型:写

返回:any

oddFooter()

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

返回:any

oddHeader()

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

返回:any

orientation()

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

返回:any

pageOrder()

打印顺序 取值 含义 nil(默认) 先列后行 "overThenDown" 先行后列 类型:写

返回:any

paperSize()

纸张大小 类型:写

返回:any

pattern()

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

返回:any

patternType()

图案样式 类型:写

返回:any

readingOrder()

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

返回:any

removeSeries(i)

删除图表Series数据

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

返回:any

right()

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

返回:any

scale()

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

返回:any

scaleCrop()

缩略图,"false"(默认),"true" 类型:写

返回:any

scaleWithDoc()

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

返回:any

script()

上下标, 取值 含义 "subscript" 下标 "superscript" 上标 类型:写

返回:any

shading()

底纹样式。 取值 含义 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()

共享文档,"false"(默认),"true" 类型:写

返回:any

showBlanksAs()

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

返回:any

showBubbleSize()

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

返回:any

showCatName()

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

返回:string

showDataTable(b)

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

参数 类型 说明
b bool object

返回:any

showFirstColumn()

第一列 类型:写

返回:any

showLastColumn()

最后一列 类型:写

返回:any

showLeaderLines()

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

返回:any

showLegendKey()

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

返回:any

showPercent()

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

返回:any

showRowStripes()

镶边行 类型:写

返回:any

showSerName()

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

返回:string

showVal()

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

返回:any

size()

字体大小。 类型:写

返回:any

strikethrough()

是否启用删除线,默认False。 类型:写

返回:any

subject()

主题 类型:写

返回:any

tableName()

表名 类型:写

返回:string

tableStyle()

表格样式 类型:写

返回:any

themeColor()

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

返回:any

themeColor1()

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

返回:any

themeColor2()

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

返回:any

title()

图表标题 类型:读/写

返回:any

tooltip()

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

返回:any

top()

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

返回:any

type()

图表类型 类型:读/写

返回:any

underline()

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

返回:any

updateTitle(t)

修改图表标题

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

返回:any

varyColors()

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

返回:any

vertical()

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

返回:any

width()

图表宽度(cm 类型:读/写

返回:any