Overview | Package | Class | Tree | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## application.workbooks.workbook.documents.document
Class Label

    java.lang.Object
      application.workbooks.workbook.documents.document.Label

public class Label
extends java.lang.Object

该类定义了设置和获取标签的方法。

Method Summary
`void` | `apply()` 应用标签。
`java.lang.String` | `getAllText()` 获取标签中的内容。
`int` | `getEndColumn()` 返回结束工作表的列号。
`int` | `getEndRow()` 返回结束工作表的行号。
`int` | `getEndSheetID()` 返回结束工作表的编号。
`boolean` | `getHasField()` 获取是否有域属性的标记。
`float` | `getHPitch()` 获取标签横向跨度。
`java.lang.String` | `getLabelName()` 获取标签名称。
`java.lang.String` | `getLabelType()` 获取标签类型。
`float` | `getLHeight()` 获取标签高度。
`float` | `getLWidth()` 获取设置标签宽度。
`int` | `getNumAcross()` 获取标签列号。
`int` | `getNumDown()` 获取标签行号。
`float[]` | `getPageSize()` 获取标签页面大小。
`int` | `getPageSizeIndex()` 获取标签页面尺寸的索引。
`float` | `getSideMargin()` 获取标签侧边距。
`boolean` | `getSingle()` 获取是否为单个标签的标记。
`int` | `getSingleCol()` 获取单个标签的列号。
`int` | `getSingleRow()` 获取单个标签的行号。
`int` | `getStartColumn()` 返回开始工作表的列号。
`int` | `getStartRow()` 返回开始工作表的行号。
`int` | `getStartSheetID()` 返回开始工作表的编号。
`float` | `getTopMargin()` 获取标签上边距。
`float` | `getVPitch()` 获取标签纵向跨度。
`void` | `setAllText(java.lang.String allText)` 设置标签中的内容。
`void` | `setEndColumn(int endColumn)` 结束工作表的列号。
`void` | `setEndRow(int endRow)` 结束工作表的行号。
`void` | `setEndSheetID(int endID)` 结束工作表的编号。
`void` | `setHasField(boolean hasField)` 设置是否有域属性的标志。
`void` | `setHPitch(float horPitch)` 设置标签横向跨度。
`void` | `setLabelName(java.lang.String labelName)` 设置标签名称。
`void` | `setLabelType(java.lang.String labelType)` 设置标签类型。
`void` | `setLHeight(float labelHeight)` 设置标签高度。
`void` | `setLWidth(float labelWidth)` 设置标签宽度。
`void` | `setNumAcross(int colNum)` 设置标签列号。
`void` | `setNumDown(int rowNum)` 设置标签行数。
`void` | `setPageSize(float[] pageSize)` 设置标签页面大小。
`void` | `setPageSizeIndex(int pageSizeIndex)` 设置标签页面尺寸的索引。
`void` | `setSideMargin(float sideMargin)` 设置标签侧边距。
`void` | `setSingle(boolean isSingle)` 设置是否为打印单个标签的标记。
`void` | `setSingleCol(int col)` 设置单个标签的列号。
`void` | `setSingleRow(int row)` 设置单个标签的行号。
`void` | `setStartColumn(int startColumn)` 开始工作表的列号。
`void` | `setStartRow(int startRow)` 开始工作表的行号。
`void` | `setStartSheetID(int startID)` 开始工作表的编号。
`void` | `setTopMargin(float topMargin)` 设置标签上边距。
`void` | `setVPitch(float verPitch)` 设置标签纵向跨度。

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Method Detail

### apply

    public void apply()

  应用标签。

  例子：

       Document doc = Application.getWorkbooks().getActiveDocument();
       Section section = doc.getSection(0);
       BaseText baseText = section.getBaseText();
       Label label = baseText.getLabel();
       label.setLabelType("用户自定义");
       label.setLabelName("myLabel");
       label.apply();

### getAllText

    public java.lang.String getAllText()

  获取标签中的内容。

  Returns:
    标签中的内容

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setAllText("Hello!");
         label.apply();
         System.out.println(label.getAllText());

### getEndColumn

    public int getEndColumn()

  返回结束工作表的列号。

  Returns:
    结束工作表的列号

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setEndColumn(2);
         label.apply();
         System.out.println(label.getEndColumn());

### getEndRow

    public int getEndRow()

  返回结束工作表的行号。

  Returns:
    结束工作表的行号

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setEndRow(5);
         label.apply();
         System.out.println(label.getEndRow());

### getEndSheetID

    public int getEndSheetID()

  返回结束工作表的编号。

  Returns:
    结束工作表的编号

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setEndSheetID(1);
         label.apply();
         System.out.println(label.getEndSheetID());

### getHasField

    public boolean getHasField()

  获取是否有域属性的标记。

  Returns:
    布尔型值，是否有域属性标志。如果有域属性的标记，则返回true；否则，返回false

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setHasField(true);
         label.apply();
         System.out.println(label.getHasField());

### getHPitch

    public float getHPitch()

  获取标签横向跨度。

  Returns:
    标签横向跨度的长度

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setHPitch(68.0f);
         label.apply();
         System.out.println(label.getHPitch());

### getLabelName

    public java.lang.String getLabelName()

  获取标签名称。

  Returns:
    标签名称

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setLabelName("myLabel");
         label.apply();
         System.out.println(label.getLabelName());

### getLabelType

    public java.lang.String getLabelType()

  获取标签类型。

  Returns:
    标签类型

         "用户自定义"
         "地址"
         "商用"

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setLabelType("用户自定义");
         label.setLabelName("myLabel");
         label.apply();
         System.out.println(label.getLabelType());

### getLHeight

    public float getLHeight()

  获取标签高度。

  Returns:
    标签高度

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setLHeight(48.0f);
         label.apply();
         System.out.println(label.getLHeight());

### getLWidth

    public float getLWidth()

  获取设置标签宽度。

  Returns:
    标签宽度

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setLWidth(58.0f);
         label.apply();
         System.out.println(label.getLWidth());

### getNumAcross

    public int getNumAcross()

  获取标签列号。

  Returns:
    标签列数

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setNumAcross(2);
         label.apply();
         System.out.println(label.getNumAcross());

### getNumDown

    public int getNumDown()

  获取标签行号。

  Returns:
    标签行数

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setNumDown(8);
         label.apply();
         System.out.println(label.getNumDown());

### getPageSize

    public float[] getPageSize()

  获取标签页面大小。

  Returns:
    标签页面大小(宽度，高度)

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setPageSize(new float[]{500.0f,500.0f});
         label.apply();
         System.out.println(label.getPageSize());

### getPageSizeIndex

    public int getPageSizeIndex()

  获取标签页面尺寸的索引。

  Returns:
    页面尺寸的索引值

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setPageSizeIndex(0);
         label.apply();
         System.out.println(label.getPageSizeIndex());

### getSideMargin

    public float getSideMargin()

  获取标签侧边距。

  Returns:
    标签侧边距

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setSideMargin(30.0f);
         label.apply();
        System.out.println(label.getSideMargin());

### getSingle

    public boolean getSingle()

  获取是否为单个标签的标记。

  Returns:
    布尔型值，是否打印单个标签。如果打印单个标签，则返回true；否则，返回false

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setSingle(true);
         label.apply();
         System.out.println(label.getSingle());

### getSingleCol

    public int getSingleCol()

  获取单个标签的列号。

  Returns:
    单个标签的列号

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setSingleCol(1);
         label.apply();
         System.out.println(label.getSingleCol());

### getSingleRow

    public int getSingleRow()

  获取单个标签的行号。

  Returns:
    单个标签的行号

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setSingleRow(1);
         label.apply();
         System.out.println(label.getSingleRow());

### getStartColumn

    public int getStartColumn()

  返回开始工作表的列号。

  Returns:
    开始工作表的列号

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setStartColumn(1);
         label.apply();
         System.out.println(label.getStartColumn());

### getStartRow

    public int getStartRow()

  返回开始工作表的行号。

  Returns:
    开始工作表的行号

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setStartRow(1);
         label.apply();
         System.out.println(label.getStartRow());

### getStartSheetID

    public int getStartSheetID()

  返回开始工作表的编号。

  Returns:
    开始工作表的编号

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setStartSheetID(1);
         label.apply();
         System.out.println(label.getStartSheetID());

### getTopMargin

    public float getTopMargin()

  获取标签上边距。

  Returns:
    标签上边距

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setTopMargin(30.0f);
         label.apply();
         System.out.println(label.getTopMargin());

### getVPitch

    public float getVPitch()

  获取标签纵向跨度。

  Returns:
    标签纵向跨度

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setVPitch(60.0f);
         label.apply();
         System.out.println(label.getVPitch());

### setAllText

    public void setAllText(java.lang.String allText)

  设置标签中的内容。

  Parameters:
    `allText` - 标签中的内容

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setAllText("Hello!");
         label.apply();

### setEndColumn

    public void setEndColumn(int endColumn)

  结束工作表的列号。

  Parameters:
    `endColumn` - 结束工作表的列号

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setEndColumn(2);
         label.apply();

### setEndRow

    public void setEndRow(int endRow)

  结束工作表的行号。

  Parameters:
    `endRow` - 结束工作表的行号

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setEndRow(5);
         label.apply();

### setEndSheetID

    public void setEndSheetID(int endID)

  结束工作表的编号。

  Parameters:
    `endID` - 结束工作表的编号

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setEndSheetID(1);
         label.apply();

### setHasField

    public void setHasField(boolean hasField)

  设置是否有域属性的标志。

  Parameters:
    `hasField` - 布尔型值，是否有域属性标志。如果为true表示有域属性标志；为false表示没有域属性标志

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setHasField(true);
         label.apply();

### setHPitch

    public void setHPitch(float horPitch)

  设置标签横向跨度。

  Parameters:
    `horPitch` - 标签横向跨度的长度

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setHPitch(68.0f);
         label.apply();

### setLabelName

    public void setLabelName(java.lang.String labelName)

  设置标签名称。

  Parameters:
    `labelName` - 标签名称

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setLabelName("myLabel");
         label.apply();

### setLabelType

    public void setLabelType(java.lang.String labelType)

  设置标签类型。

  Parameters:
    `labelType` - 标签类型

         "用户自定义"
         "地址"
         "商用"

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setLabelType("用户自定义");
         label.setLabelName("myLabel");
         label.apply();

### setLHeight

    public void setLHeight(float labelHeight)

  设置标签高度。

  Parameters:
    `labelHeight` - 标签高度

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setLHeight(48.0f);
         label.apply();

### setLWidth

    public void setLWidth(float labelWidth)

  设置标签宽度。

### setNumAcross

    public void setNumAcross(int colNum)

  设置标签列号。

  Parameters:
    `colNum` - 标签列数

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setNumAcross(2);
         label.apply();

### setNumDown

    public void setNumDown(int rowNum)

  设置标签行数。

  Parameters:
    `rowNum` - 标签行数

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setNumDown(8);
         label.apply();

### setPageSize

    public void setPageSize(float[] pageSize)

  设置标签页面大小。

  Parameters:
    `pageSize` - 标签页面大小(宽度，高度)

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setPageSize(new float[]{500.0f,500.0f});
         label.apply();

### setPageSizeIndex

    public void setPageSizeIndex(int pageSizeIndex)

  设置标签页面尺寸的索引。

  Parameters:
    `pageSizeIndex` - 页面尺寸的索引值

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setPageSizeIndex(0);
         label.apply();

### setSideMargin

    public void setSideMargin(float sideMargin)

  设置标签侧边距。

  Parameters:
    `sideMargin` - 标签侧边距

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setSideMargin(30.0f);
         label.apply();

### setSingle

    public void setSingle(boolean isSingle)

  设置是否为打印单个标签的标记。

  Parameters:
    `isSingle` - 布尔型值，是否打印单个标签。如果为true表示打印单个标签；否则不打印单个标签

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setSingle(true);
         label.apply();

### setSingleCol

    public void setSingleCol(int col)

  设置单个标签的列号。

  Parameters:
    `col` - 单个标签的列号

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setSingleCol(1);
         label.apply();

### setSingleRow

    public void setSingleRow(int row)

  设置单个标签的行号。

  Parameters:
    `row` - 单个标签的行号

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setSingleRow(1);
         label.apply();

### setStartColumn

    public void setStartColumn(int startColumn)

  开始工作表的列号。

  Parameters:
    `startColumn` - 开始工作表的列号

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setStartColumn(1);
         label.apply();

### setStartRow

    public void setStartRow(int startRow)

  开始工作表的行号。

  Parameters:
    `startRow` - 开始工作表的行号

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setStartRow(1);
         label.apply();

### setStartSheetID

    public void setStartSheetID(int startID)

  开始工作表的编号。

  Parameters:
    `startID` - 开始工作表的编号

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setStartSheetID(1);
         label.apply();

### setTopMargin

    public void setTopMargin(float topMargin)

  设置标签上边距。

  Parameters:
    `topMargin` - 标签上边距

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setTopMargin(30.0f);
         label.apply();

### setVPitch

    public void setVPitch(float verPitch)

  设置标签纵向跨度。

  Parameters:
    `verPitch` - 标签纵向跨度

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Label label = baseText.getLabel();
         label.setVPitch(60.0f);
         label.apply();

Overview | Package | Class | Tree | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

版权所有 2001-2004 无锡永中科技有限公司