概述 | 软件包 | 类 | 使用 | 树 | 索引 | 帮助

上一个类 下一个类 | 框架 无框架
摘要： 嵌套 | 字段 | 构造函数 | 方法 | 详细信息： 字段 | 构造函数 | 方法

## application.workbooks.workbook.style.fill
类 WaterMarkAttribute

    java.lang.Object
      application.workbooks.workbook.style.fill.WaterMarkAttribute

    public class WaterMarkAttribute

extends java.lang.Object

此类用于设置水印属性。

构造函数摘要
`WaterMarkAttribute()` 默认构建器

方法摘要
`java.awt.Color` | `getColor()` 返回文本水印的颜色。
`java.lang.String` | `getFontFamily()` 返回文本水印字体名称。
`int` | `getFontSize()` 返回文本水印字体大小。
`java.lang.String` | `getPicturePath()` 返回图片水印的路径。
`java.lang.String` | `getText()` 返回文本水印内容。
`int` | `getType()` 返回水印类型。
`int` | `getZoom()` 返回图片水印的缩放大小。
`boolean` | `isDim()` 返回水印是否是冲蚀效果。
`boolean` | `isLean()` 返回水印是否倾斜
`boolean` | `isSemiTransparent()` 返回水印是否为半透明。
`void` | `setColor(java.awt.Color color)` 设置文本水印的颜色。
`void` | `setDim(boolean isDim)` 设置水印是否使用冲蚀效果。
`void` | `setFontFamily(java.lang.String family)` 设置文本水印字体名称。
`void` | `setFontSize(int size)` 设置文本水印字体大小。
`void` | `setLean(boolean lean)` 设置水印是否倾斜
`void` | `setPicturePath(java.lang.String path)` 设置图片水印。
`void` | `setSemiTransparent(boolean isSemiTransparent)` 设置水印是否为半透明。
`void` | `setText(java.lang.String text)` 设置文本水印内容。
`void` | `setType(int type)` 设置水印类型。
`void` | `setZoom(float zoom)` 设置图片水印的缩放大小。

从类 java.lang.Object 继承的方法
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

构造函数详细信息

### WaterMarkAttribute

    public WaterMarkAttribute()

  默认构建器

方法详细信息

### getColor

    public java.awt.Color getColor()

  返回文本水印的颜色。

  返回：
    文本水印的颜色

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
         .getActiveDocument();
         WaterMarkAttribute watermark = doc.getWatermarkAttribute();
         watermark.setType(WatermarkConstants.TEXT_WATERMARK);
         watermark.setText("保密");
         watermark.setColor(java.awt.Color.RED);
         doc.setWatermarkAttribute(watermark);
         System.out.println(doc.getWatermarkAttribute().getColor());

### getFontFamily

    public java.lang.String getFontFamily()

  返回文本水印字体名称。

  返回：
    字体名称

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
         .getActiveDocument();
         WaterMarkAttribute watermark = doc.getWatermarkAttribute();
         watermark.setType(WatermarkConstants.TEXT_WATERMARK);
         watermark.setText("保密");
         watermark.setFontFamily("宋体");
         doc.setWatermarkAttribute(watermark);
         System.out.println(doc.getWatermarkAttribute().getFontFamily());

### getFontSize

    public int getFontSize()

  返回文本水印字体大小。

  返回：
    字体大小

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
         .getActiveDocument();
         WaterMarkAttribute watermark = doc.getWatermarkAttribute();
         watermark.setType(WatermarkConstants.TEXT_WATERMARK);
         watermark.setText("保密");
         watermark.setFontSize(24);
         doc.setWatermarkAttribute(watermark);
         System.out.println(doc.getWatermarkAttribute().getFontSize());

### getPicturePath

    public java.lang.String getPicturePath()

  返回图片水印的路径。

  返回：
    图片水印的路径

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
         .getActiveDocument();
         WaterMarkAttribute watermark = doc.getWatermarkAttribute();
         watermark.setType(WatermarkConstants.PICTURE_WATERMARK);
         watermark.setPicturePath("g://609.JPG");
         doc.setWatermarkAttribute(watermark);
         System.out.println(doc.getWatermarkAttribute().getPicturePath());

### getText

    public java.lang.String getText()

  返回文本水印内容。

  返回：
    水印内容

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
         .getActiveDocument();
         WaterMarkAttribute watermark = doc.getWatermarkAttribute();
         watermark.setType(WatermarkConstants.TEXT_WATERMARK);
         watermark.setText("保密");
         doc.setWatermarkAttribute(watermark);
         System.out.println(doc.getWatermarkAttribute().getText());

### getType

    public int getType()

  返回水印类型。

  返回：
    水印类型

         其常量和相应的值如下：
           WatermarkConstants.NO_WATERMARK        (无水印)
           WatermarkConstants.TEXT_WATERMARK      (文本水印)
           WatermarkConstants.PICTURE_WATERMARK   (图片水印)

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
         .getActiveDocument();
         WaterMarkAttribute watermark = doc.getWatermarkAttribute();
         watermark.setType(WatermarkConstants.PICTURE_WATERMARK);
         watermark.setPicturePath("g://609.JPG");
         doc.setWatermarkAttribute(watermark);
         System.out.println(doc.getWatermarkAttribute().getType());

### getZoom

    public int getZoom()

  返回图片水印的缩放大小。

  返回：
    图片水印的缩放大小

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
         .getActiveDocument();
         WaterMarkAttribute watermark = doc.getWatermarkAttribute();
         watermark.setType(WatermarkConstants.PICTURE_WATERMARK);
         watermark.setPicturePath("g://609.JPG");
         watermark.setZoom(150);
         doc.setWatermarkAttribute(watermark);
         System.out.println(doc.getWatermarkAttribute().getZoom());

### isDim

    public boolean isDim()

  返回水印是否是冲蚀效果。

  返回：
    是否是冲蚀效果

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
         .getActiveDocument();
         WaterMarkAttribute watermark = doc.getWatermarkAttribute();
         watermark.setType(WatermarkConstants.TEXT_WATERMARK);
         watermark.setText("保密");
         watermark.setDim(true);
         doc.setWatermarkAttribute(watermark);
         System.out.println(doc.getWatermarkAttribute().isDim());

### isLean

    public boolean isLean()

  返回水印是否倾斜

  返回：
    水印是否倾斜

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
         .getActiveDocument();
         WaterMarkAttribute watermark = doc.getWatermarkAttribute();
         watermark.setType(WatermarkConstants.TEXT_WATERMARK);
         watermark.setText("保密");
         watermark.setLean(true);
         doc.setWatermarkAttribute(watermark);
         System.out.println(doc.getWatermarkAttribute().isLean());

### isSemiTransparent

    public boolean isSemiTransparent()

  返回水印是否为半透明。

  返回：
    水印是否半透明。

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
         .getActiveDocument();
         WaterMarkAttribute watermark = doc.getWatermarkAttribute();
         watermark.setType(WatermarkConstants.TEXT_WATERMARK);
         watermark.setText("保密");
         watermark.setSemiTransparent(true);
         doc.setWatermarkAttribute(watermark);
         System.out.println(doc.getWatermarkAttribute().isSemiTransparent());

### setColor

    public void setColor(java.awt.Color color)

  设置文本水印的颜色。

  参数：
    `color` - 文本水印的颜色

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
         .getActiveDocument();
         WaterMarkAttribute watermark = doc.getWatermarkAttribute();
         watermark.setType(WatermarkConstants.TEXT_WATERMARK);
         watermark.setText("保密");
         watermark.setColor(java.awt.Color.RED);
         doc.setWatermarkAttribute(watermark);

  抛出：
    `application.exceptions.MacroRunException` - 此方法只有在水印类型为文字水印类型时才有效
    `application.exceptions.MacroRunException` - 颜色值不能为空

### setDim

    public void setDim(boolean isDim)

  设置水印是否使用冲蚀效果。

  参数：
    `isDim` - true为使用冲蚀效果

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
         .getActiveDocument();
         WaterMarkAttribute watermark = doc.getWatermarkAttribute();
         watermark.setType(WatermarkConstants.TEXT_WATERMARK);
         watermark.setText("保密");
         watermark.setDim(true);
         doc.setWatermarkAttribute(watermark);

  抛出：
    `application.exceptions.MacroRunException` - 此方法只有在水印类型为图片水印类型时才有效

### setFontFamily

    public void setFontFamily(java.lang.String family)

  设置文本水印字体名称。

  参数：
    `family` - 字体名称

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
         .getActiveDocument();
         WaterMarkAttribute watermark = doc.getWatermarkAttribute();
         watermark.setType(WatermarkConstants.TEXT_WATERMARK);
         watermark.setText("保密");
         watermark.setFontFamily("宋体");
         doc.setWatermarkAttribute(watermark);

  抛出：
    `application.exceptions.MacroRunException` - 此方法只有在水印类型为文字水印类型时才有效
    `application.exceptions.MacroRunException` - 字体名称不能为空
    `application.exceptions.MacroRunException` - 字体名称在当前操作系统中不存在

### setFontSize

    public void setFontSize(int size)

  设置文本水印字体大小。取值范围为1 ～ 1638磅之间。

  参数：
    `size` - 字体大小

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
         .getActiveDocument();
         WaterMarkAttribute watermark = doc.getWatermarkAttribute();
         watermark.setType(WatermarkConstants.TEXT_WATERMARK);
         watermark.setText("保密");
         watermark.setFontSize(24);
         doc.setWatermarkAttribute(watermark);

  抛出：
    `application.exceptions.MacroRunException` - 此方法只有在水印类型为文字水印类型时才有效
    `application.exceptions.MacroRunException` - 参数越界，字体大小必须在1 ～ 1638磅之间

### setLean

    public void setLean(boolean lean)

  设置水印是否倾斜

  参数：
    `lean` - true为水印倾斜

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
         .getActiveDocument();
         WaterMarkAttribute watermark = doc.getWatermarkAttribute();
         watermark.setType(WatermarkConstants.TEXT_WATERMARK);
         watermark.setText("保密");
         watermark.setLean(true);
         doc.setWatermarkAttribute(watermark);

  抛出：
    `application.exceptions.MacroRunException` - 此方法只有在水印类型为文字水印类型时才有效

### setPicturePath

    public void setPicturePath(java.lang.String path)

  设置图片水印。

  参数：
    `path` - 图片水印路径

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
         .getActiveDocument();
         WaterMarkAttribute watermark = doc.getWatermarkAttribute();
         watermark.setType(WatermarkConstants.PICTURE_WATERMARK);
         watermark.setPicturePath("g://609.JPG");
         doc.setWatermarkAttribute(watermark);

  抛出：
    `application.exceptions.MacroRunException` - 此方法只有在水印类型为图片水印类型时才有效
    `application.exceptions.MacroRunException` - 当参数为空
    `application.exceptions.MacroRunException` - 当图片文件路径不存在

### setSemiTransparent

    public void setSemiTransparent(boolean isSemiTransparent)

  设置水印是否为半透明。

  参数：
    `isSemiTransparent` - true为半透明

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
         .getActiveDocument();
         WaterMarkAttribute watermark = doc.getWatermarkAttribute();
         watermark.setType(WatermarkConstants.TEXT_WATERMARK);
         watermark.setText("保密");
         watermark.setSemiTransparent(true);
         doc.setWatermarkAttribute(watermark);

  抛出：
    `application.exceptions.MacroRunException` - 此方法只有在水印类型为文字水印类型时才有效

### setText

    public void setText(java.lang.String text)

  设置文本水印内容。

  参数：
    `text` - 水印内容

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
         .getActiveDocument();
         WaterMarkAttribute watermark = doc.getWatermarkAttribute();
         watermark.setType(WatermarkConstants.TEXT_WATERMARK);
         watermark.setText("保密");
         doc.setWatermarkAttribute(watermark);

  抛出：
    `application.exceptions.MacroRunException` - 此方法只有在水印类型为文字水印类型时才有效
    `application.exceptions.MacroRunException` - 当文本水印内容为空

### setType

    public void setType(int type)

  设置水印类型。

  参数：
    `type` - 水印类型

         其常量和相应的值如下：
           WatermarkConstants.NO_WATERMARK        (无水印)
           WatermarkConstants.TEXT_WATERMARK      (文本水印)
           WatermarkConstants.PICTURE_WATERMARK   (图片水印)

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
         .getActiveDocument();
         WaterMarkAttribute watermark = doc.getWatermarkAttribute();
         watermark.setType(WatermarkConstants.PICTURE_WATERMARK);
         watermark.setPicturePath("g://609.JPG");
         doc.setWatermarkAttribute(watermark);

  抛出：
    `application.exceptions.MacroRunException` - 当水印类型的常量不存在

### setZoom

    public void setZoom(float zoom)

  设置图片水印的缩放大小。

  参数：
    `zoom` - 图片水印的缩放大小

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
         .getActiveDocument();
         WaterMarkAttribute watermark = doc.getWatermarkAttribute();
         watermark.setType(WatermarkConstants.PICTURE_WATERMARK);
         watermark.setPicturePath("g://609.JPG");
         watermark.setZoom(150.0f);
         doc.setWatermarkAttribute(watermark);

  抛出：
    `application.exceptions.MacroRunException` - 此方法只有在水印类型为图片水印类型时才有效

概述 | 软件包 | 类 | 使用 | 树 | 索引 | 帮助

上一个类 下一个类 | 框架 无框架
摘要： 嵌套 | 字段 | 构造函数 | 方法 | 详细信息： 字段 | 构造函数 | 方法