Style API 参考

概述

Style API 提供管理 Excel 工作表中单元格格式化样式的函数,包括数字格式、字体、边框、填充、对齐方式和保护设置。

数字格式

int style_set_numfmt(StyleHandle style, const char *numFmtCode)

设置自定义数字格式代码。

参数:
  • style -- Style 句柄

  • numFmtCode -- 数字格式代码字符串。

返回:

成功返回 1,失败返回 0。

const char *style_numfmt_code(StyleHandle style)

获取数字格式代码。

参数:
  • style -- Style 句柄

返回:

数字格式代码字符串。

int style_numfmt_id(StyleHandle style)

获取数字格式 ID。

参数:
  • style -- Style 句柄

返回:

数字格式 ID。

int style_set_numfmt_id(StyleHandle style, int numFmtId)

通过 ID 设置数字格式。

参数:
  • style -- Style 句柄

  • numFmtId -- 数字格式 ID。

返回:

成功返回 1,失败返回 0。

字体设置

void style_set_font(StyleHandle style, const char *name, int fontSize)

设置字体名称和大小。

参数:
  • style -- Style 句柄

  • name -- 字体名称。

  • fontSize -- 字体大小(磅值),0 表示使用原字体大小。

const char *style_font_name(StyleHandle style)

获取字体名称。

参数:
  • style -- Style 句柄

返回:

字体名称。

int style_font_size(StyleHandle style)

获取字体大小。

参数:
  • style -- Style 句柄

返回:

字体大小(磅值),0 表示使用原字体大小。

void style_set_font_size(StyleHandle style, int size)

设置字体大小。

参数:
  • style -- Style 句柄

  • size -- 字体大小(磅值),0 表示使用原字体大小。

int style_italic(StyleHandle style)

检查字体是否为斜体。

参数:
  • style -- Style 句柄

返回:

斜体返回 1,否则返回 0。

void style_set_italic(StyleHandle style, int italic)

设置斜体字体样式。

参数:
  • style -- Style 句柄

  • italic -- 1 表示斜体,0 表示正常。

int style_strikeout(StyleHandle style)

检查字体是否有删除线。

参数:
  • style -- Style 句柄

返回:

有删除线返回 1,否则返回 0。

void style_set_strikeout(StyleHandle style, int strikeOut)

设置删除线字体样式。

参数:
  • style -- Style 句柄

  • strikeOut -- 1 表示删除线,0 表示正常。

COLORREF style_font_color(StyleHandle style)

获取字体颜色。

参数:
  • style -- Style 句柄

返回:

字体颜色(COLORREF 格式)。

void style_set_font_color(StyleHandle style, COLORREF color)

设置字体颜色。

参数:
  • style -- Style 句柄

  • color -- 字体颜色(COLORREF 格式)。

int style_bold(StyleHandle style)

检查字体是否为粗体。

参数:
  • style -- Style 句柄

返回:

粗体返回 1,否则返回 0。

void style_set_bold(StyleHandle style, int bold)

设置粗体字体样式。

参数:
  • style -- Style 句柄

  • bold -- 1 表示粗体,0 表示正常。

int style_font_vert_align(StyleHandle style)

获取字体垂直对齐方式。

参数:
  • style -- Style 句柄

返回:

垂直对齐方式(参见 VertAlignRunEnum)。

void style_set_font_vert_align(StyleHandle style, int v_alignRun)

设置字体垂直对齐方式。

参数:
  • style -- Style 句柄

  • v_alignRun -- 垂直对齐方式(参见 VertAlignRunEnum)。

int style_underlined(StyleHandle style)

检查字体是否有下划线。

参数:
  • style -- Style 句柄

返回:

有下划线返回 1,否则返回 0。

void style_set_underline(StyleHandle style, int underline)

设置下划线样式。

参数:
  • style -- Style 句柄

  • underline -- 下划线样式(参见 UnderlineEnum)。

边框设置

int style_border(StyleHandle style, int index)

获取特定边框的边框样式。

参数:
返回:

边框样式(参见 BorderStyleEnum)。

int style_set_border(StyleHandle style, int index, int bs)

设置特定边框的边框样式。

参数:
返回:

成功返回 1,失败返回 0。

COLORREF style_border_color(StyleHandle style, int index)

获取特定边框的边框颜色。

参数:
返回:

边框颜色(COLORREF 格式)。

int style_set_border_color(StyleHandle style, int index, COLORREF color)

设置特定边框的边框颜色。

参数:
  • style -- Style 句柄

  • index -- 边框索引(参见 BorderIndexEnum)。

  • color -- 边框颜色(COLORREF 格式)。

返回:

成功返回 1,失败返回 0。

填充和图案设置

int style_fill_pattern(StyleHandle style)

获取填充图案类型。

参数:
  • style -- Style 句柄

返回:

填充图案类型(参见 PatternTypeEnum)。

void style_set_fill_pattern(StyleHandle style, int pattern)

设置填充图案类型。

参数:
  • style -- Style 句柄

  • pattern -- 填充图案类型(参见 PatternTypeEnum)。

COLORREF style_pattern_fg_color(StyleHandle style)

获取图案前景色。

参数:
  • style -- Style 句柄

返回:

前景色(COLORREF 格式)。

void style_set_pattern_fg_color(StyleHandle style, COLORREF color)

设置图案前景色。

参数:
  • style -- Style 句柄

  • color -- 前景色(COLORREF 格式)。

COLORREF style_pattern_bg_color(StyleHandle style)

获取图案背景色。

参数:
  • style -- Style 句柄

返回:

背景色(COLORREF 格式)。

void style_set_pattern_bg_color(StyleHandle style, COLORREF color)

设置图案背景色。

参数:
  • style -- Style 句柄

  • color -- 背景色(COLORREF 格式)。

对齐方式设置

int style_align_h(StyleHandle style)

获取水平对齐方式。

参数:
  • style -- Style 句柄

返回:

水平对齐方式(参见 HAlignEnum)。

void style_set_align_h(StyleHandle style, int h_alignment)

设置水平对齐方式。

参数:
  • style -- Style 句柄

  • h_alignment -- 水平对齐方式(参见 HAlignEnum)。

int style_align_v(StyleHandle style)

获取垂直对齐方式。

参数:
  • style -- Style 句柄

返回:

垂直对齐方式(参见 VAlignEnum)。

void style_set_align_v(StyleHandle style, int v_alignment)

设置垂直对齐方式。

参数:
  • style -- Style 句柄

  • v_alignment -- 垂直对齐方式(参见 VAlignEnum)。

int style_wrap(StyleHandle style)

检查是否启用文本自动换行。

参数:
  • style -- Style 句柄

返回:

启用文本自动换行返回 1,否则返回 0。

void style_set_wrap(StyleHandle style, int wrap)

设置文本自动换行。

参数:
  • style -- Style 句柄

  • wrap -- 1 启用文本自动换行,0 禁用。

int style_rotation(StyleHandle style)

获取文本旋转角度。

参数:
  • style -- Style 句柄

返回:

文本旋转角度(度)。

void style_set_rotation(StyleHandle style, int rotation)

设置文本旋转。

参数:
  • style -- Style 句柄

  • rotation -- 文本旋转角度(度)。

int style_indent(StyleHandle style)

获取缩进字符数。

参数:
  • style -- Style 句柄

返回:

缩进的字符数

void style_set_indent(StyleHandle style, int indent)

设置缩进的字符数

参数:
  • style -- Style 句柄

  • indent -- 缩进的字符数

int style_shrink_to_fit(StyleHandle style)

检查是否启用缩小字体填充。

参数:
  • style -- Style 句柄

返回:

启用缩小字体填充返回 1,否则返回 0。

void style_set_shrink_to_fit(StyleHandle style, int shrinkToFit)

设置缩小字体填充。

参数:
  • style -- Style 句柄

  • shrinkToFit -- 1 启用缩小字体填充,0 禁用。

保护设置

int style_cell_locked(StyleHandle style)

检查单元格是否锁定。

参数:
  • style -- Style 句柄

返回:

单元格锁定返回 1,否则返回 0。

void style_set_cell_locked(StyleHandle style, int locked)

设置单元格锁定状态。

参数:
  • style -- Style 句柄

  • locked -- 1 锁定单元格,0 解锁。

int style_cell_hidden(StyleHandle style)

检查单元格公式是否隐藏。

参数:
  • style -- Style 句柄

返回:

公式隐藏返回 1,否则返回 0。

void style_set_cell_hidden(StyleHandle style, int hidden)

设置单元格公式隐藏状态。

参数:
  • style -- Style 句柄

  • hidden -- 1 隐藏公式,0 显示。

样式移除

void style_unapply_numfmt(StyleHandle style)

从样式中移除数字格式。

参数:
  • style -- Style 句柄

void style_unapply_font(StyleHandle style)

从样式中移除字体设置。

参数:
  • style -- Style 句柄

void style_unapply_border(StyleHandle style)

从样式中移除边框设置。

参数:
  • style -- Style 句柄

void style_unapply_fill(StyleHandle style)

从样式中移除填充设置。

参数:
  • style -- Style 句柄

void style_unapply_alignment(StyleHandle style)

从样式中移除对齐方式设置。

参数:
  • style -- Style 句柄

void style_unapply_protection(StyleHandle style)

从样式中移除保护设置。

参数:
  • style -- Style 句柄

资源管理

void style_release(StyleHandle style)

释放样式资源。

参数:
  • style -- 要释放的样式句柄。

枚举类型

相关枚举类型的定义请参考 枚举类型