ILabelOptions

Interface ILabelOptions

---

public interface ILabelOptions

指示单元格标签选项。

使用此接口可配置区域的水印标签显示方式，包括其位置、可见性、字体、前景色和边距。可以从 IRange.getLabelOptions() 访问这些选项，并使用LabelAlignment 和 LabelVisibility 控制标签布局。仅适用于 SpreadJS。

 worksheet.getRange("A1").setValue("Name");
 worksheet.getRange("A1").setWatermark("Required");
 ILabelOptions labelOptions = worksheet.getRange("A1").getLabelOptions();
 labelOptions.setAlignment(LabelAlignment.topLeft);
 labelOptions.setVisibility(LabelVisibility.visible);
 

• Method Summary

  All MethodsInstance MethodsAbstract Methods

  Modifier and Type

  Method

  Description

  LabelAlignment

  getAlignment()

  获取单元格中的水印标签对齐方式。

  IFont

  getFont()

  返回 IFont 的实例，可用于获取和设置由此 IRange 表示的水印的字体属性。

  Color

  getForeColor()

  获取区域中水印标签的前景色。

  Margin

  getMargin()

  获取区域的水印标签边距。

  LabelVisibility

  getVisibility()

  获取水印标签的可见性模式。

  void

  setAlignment(LabelAlignment alignment)

  设置单元格中的水印标签对齐方式。

  void

  setForeColor(Color color)

  设置区域中水印标签的前景色。

  void

  setMargin(Margin margin)

  设置区域的水印标签边距。

  void

  setVisibility(LabelVisibility visibility)

  设置水印标签的可见性模式。

• Method Details

  • getAlignment

    LabelAlignment getAlignment()

    获取单元格中的水印标签对齐方式。

    此属性控制水印标签在单元格中的显示位置。返回值是 LabelAlignment 常量之一。如果未设置位置，此方法返回 LabelAlignment.topLeft。仅适用于 SpreadJS。

    
     IRange range = worksheet.getRange("A1");
     range.setWatermark("Required");
     range.getLabelOptions().setAlignment(LabelAlignment.bottomCenter);
     LabelAlignment alignment = range.getLabelOptions().getAlignment();
     

    Returns:

    单元格中的水印标签对齐方式。

  • setAlignment

    void setAlignment(LabelAlignment alignment)

    设置单元格中的水印标签对齐方式。

    使用 LabelAlignment 可将水印标签放置在单元格顶部或底部，并设置为左对齐、居中或右对齐。

    
     IRange range = worksheet.getRange("A1");
     range.setWatermark("Required");
     range.getLabelOptions().setAlignment(LabelAlignment.bottomCenter);
     

    Parameters:

    alignment - 单元格中的水印标签对齐方式。

  • getVisibility

    LabelVisibility getVisibility()

    获取水印标签的可见性模式。

    返回值是 LabelVisibility 常量之一。如果未设置可见性，此方法返回 LabelVisibility.auto。仅适用于 SpreadJS。

    
     IRange range = worksheet.getRange("A1");
     range.setWatermark("Required");
     range.getLabelOptions().setVisibility(LabelVisibility.visible);
     LabelVisibility visibility = range.getLabelOptions().getVisibility();
     

    Returns:

    水印标签的可见性模式。

  • setVisibility

    void setVisibility(LabelVisibility visibility)

    设置水印标签的可见性模式。

    使用 LabelVisibility.visible 可始终在填充区域显示水印，使用 LabelVisibility.hidden 可根据单元格值在单元格区域显示水印，或使用 LabelVisibility.auto 在两种行为之间自动切换。仅适用于 SpreadJS。

    
     IRange range = worksheet.getRange("A1");
     range.setWatermark("Required");
     range.getLabelOptions().setVisibility(LabelVisibility.visible);
     

    Parameters:

    visibility - 水印标签的可见性模式。

  • getForeColor

    Color getForeColor()

    获取区域中水印标签的前景色。

    使用此属性可获取应用于区域中水印标签的前景色。仅适用于 SpreadJS。

    
     IRange range = worksheet.getRange("A1");
     range.setWatermark("Required");
     range.getLabelOptions().setForeColor(Color.GetRed());
     Color color = range.getLabelOptions().getForeColor();
     

    Returns:

    区域中水印标签的前景色。

  • setForeColor

    void setForeColor(Color color)

    设置区域中水印标签的前景色。

    使用此属性可设置应用于区域中水印标签的前景色。仅适用于 SpreadJS。

    
     IRange range = worksheet.getRange("A1");
     range.setWatermark("Required");
     range.getLabelOptions().setForeColor(Color.GetRed());
     

    Parameters:

    color - 区域中水印标签的前景色。

  • getFont

    IFont getFont()

    返回 IFont 的实例，可用于获取和设置由此 IRange 表示的水印的字体属性。

    使用返回的字体对象可配置区域的水印标签字体，例如粗体样式、斜体样式、大小和颜色。仅适用于 SpreadJS。

    
     IRange range = worksheet.getRange("A1");
     range.setWatermark("Required");
     IFont font = range.getLabelOptions().getFont();
     font.setBold(true);
     font.setColor(Color.GetBlue());
     

    Returns:

    定义此区域水印字体属性的 IFont 对象。

  • getMargin

    Margin getMargin()

    获取区域的水印标签边距。

    使用此属性可获取相对于单元格的水印标签边距（以像素为单位）。返回的 Margin 定义水印标签使用的上、右、下、左间距。如果未设置边距，则返回 null。仅适用于 SpreadJS。

    
     IRange range = worksheet.getRange("A1");
     range.setWatermark("Required");
     range.getLabelOptions().setMargin(new Margin(2, 4, 2, 4));
     Margin margin = range.getLabelOptions().getMargin();
     int right = margin.getRight();
     

    Returns:

    区域的水印标签边距；如果未设置边距，则为 null。

  • setMargin

    void setMargin(Margin margin)

    设置区域的水印标签边距。

    边距由一个 Margin 对象指定，以相对于单元格的像素为单位。

    
     IRange range = worksheet.getRange("A1");
     range.setWatermark("Required");
     range.getLabelOptions().setMargin(new Margin(15, 0, 0, 0));
     Margin margin = range.getLabelOptions().getMargin();
     

    Parameters:

    margin - 相对于单元格的水印标签边距（以像素为单位）。