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.style.hyperlink
Class HyperlinkAttribute

    java.lang.Object
      application.workbooks.workbook.style.hyperlink.HyperlinkAttribute

Direct Known Subclasses:
  PgHyperlinkAttribute, WpHyperlinkAttribute

public class HyperlinkAttribute
extends java.lang.Object

该类封装了一些超级链接的基本属性。WpHyperlinkAttribute和PgHyperlinkAttribute类继承了该类。

Constructor Summary
`HyperlinkAttribute(Workbook workbook)` 新建超链接的属性。

Method Summary
`void` | `creatNewDocument(java.lang.String fileName)` 超链到一个新的文件（仅对新建文件有效)。
`java.lang.String` | `getShowText()` 获得超链接的显示文本。
`void` | `hyperLinkBookMark(Document document, int bookMarkIndex)` 设置超链接到文字处理文档中的书签。
`void` | `hyperLinkCellReference(Worksheet worksheet, java.lang.String cellAddress)` 设置超链接到工作表中的某单元格。
`void` | `hyperLinkDefinedName(Worksheet worksheet, java.lang.String rangeName)` 设置超链接到工作表中的定义有名称的单元格区域。
`void` | `hyperLinkHeading(Document document, int headingIndex)` 设置超链接到文字处理文档中的标题。
`void` | `hyperLinkSpreadsheet(java.lang.String useText)` 超链到电子表格文档。
`void` | `hyperlinkToCustomShowList(Presentation pg, java.lang.String listName)` 设置超链接到简报制作应用中的自定义播放列表。
`void` | `hyperlinkToCustomShowList(java.lang.String appName, java.lang.String listName)` 设置超链接到简报制作应用中的自定义播放列表。
`void` | `hyperLinkTopOfDocumnet(Document document)` 设置超链接到文档顶部。
`void` | `hyperlinkToSlide(Presentation pg, int slideIndex)` 设置超链接到简报制作文档中的某一幻灯片。
`void` | `hyperlinkToSlide(java.lang.String appName, int slideIndex)` 设置链接到简报制作应用中的某一幻灯片。
`void` | `setEmailAddress(java.lang.String email)` 设置需要超链的邮件地址（仅对电子邮件有效)。
`void` | `setEmailSubject(java.lang.String subject)` 设置需要超链的邮件主题（仅对电子邮件有效)。
`void` | `setHyperlinkFileName(java.lang.String fileName)` 设置需要超链到文件或者网页（仅对原始的文件或网页有效)。
`void` | `setHyperlinkType(int type)` 设置超链接的类型。
`void` | `setScreenTip(java.lang.String screenTip)` 设置超链接的屏幕提示。
`void` | `setShowText(java.lang.Object showText)` 设置超链接的显示文本。

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

Constructor Detail

### HyperlinkAttribute

    public HyperlinkAttribute(Workbook workbook)

  新建超链接的属性。

Parameters:
  `workbook` - 需要添加超链接属性的工作簿

Method Detail

### creatNewDocument

    public void creatNewDocument(java.lang.String fileName)

  超链到一个新的文件（仅对新建文件有效)。

  Parameters:
    `fileName` - 新建的文件的完全路径

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         WpHyperlinkAttribute hyperlink = baseText.getHyperlink(0,5);
         hyperlink.setHyperlinkType(2);
         hyperlink.creatNewDocument("d:/b.eio");
         hyperlink.apply();

### getShowText

    public java.lang.String getShowText()

  获得超链接的显示文本。

  Returns:
    String 超链接的显示文本

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         WpHyperlinkAttribute hyperlink = baseText.getHyperlink(0,5);
         hyperlink.setHyperlinkType(0);
         hyperlink.setHyperlinkFileName("d:/a.txt");
         hyperlink.setShowText("myHyperlink!");
         hyperlink.apply();
         System.out.println(hyperlink.getShowText ());

### hyperLinkBookMark

    public void hyperLinkBookMark(Document document,
                                  int bookMarkIndex)

  设置超链接到文字处理文档中的书签。

  Parameters:
    `document` - 文字处理文档对象
    `bookMarkIndex` - 书签的索引号

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         WpHyperlinkAttribute hyperlink = baseText.getHyperlink(0,5);
         hyperlink.setHyperlinkType(0);
         hyperlink.hyperLinkBookMark(doc,0);
         hyperlink.apply();

### hyperLinkCellReference

    public void hyperLinkCellReference(Worksheet worksheet,
                                       java.lang.String cellAddress)

  设置超链接到工作表中的某单元格。

  Parameters:
    `worksheet` - 工作表对象
    `cellAddress` - 工作表中指定的单元格地址

    例子：

         Application.gotoProduct(0);
         Worksheet worksheet = Application.getWorkbooks().getActiveWorkbook().getWorksheet("工作表1");
         Application.gotoProduct(1);
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         WpHyperlinkAttribute hyperlink = baseText.getHyperlink(0,2);
         hyperlink.setHyperlinkType(1);
         hyperlink.setShowText("aa");
         hyperlink.setScreenTip("myAA");
         hyperlink.hyperLinkCellReference(worksheet,"B5");
         hyperlink.apply();

### hyperLinkDefinedName

    public void hyperLinkDefinedName(Worksheet worksheet,
                                     java.lang.String rangeName)

  设置超链接到工作表中的定义有名称的单元格区域。

  Parameters:
    `worksheet` - 工作表对象
    `rangeName` - 工作表中的定义的区域名称

    例子：

         Application.gotoProduct(0);
         Worksheet worksheet = Application.getWorkbooks().getActiveWorkbook().getWorksheet("工作表1");
         Application.gotoProduct(1);
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         WpHyperlinkAttribute hyperlink = baseText.getHyperlink(0,2);
         hyperlink.setHyperlinkType(1);
         hyperlink.setShowText("aa");
         hyperlink.setScreenTip("myAA");
         hyperlink.hyperLinkDefinedName(worksheet,"range");
         hyperlink.apply();

### hyperLinkHeading

    public void hyperLinkHeading(Document document,
                                 int headingIndex)

  设置超链接到文字处理文档中的标题。

  Parameters:
    `document` - 文字处理文档对象
    `headingIndex` - 标题的索引号

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         WpHyperlinkAttribute hyperlink = baseText.getHyperlink(0,2);
         hyperlink.setHyperlinkType(1);
         hyperlink.setShowText("aa");
         hyperlink.setScreenTip("myAA");
         hyperlink.hyperLinkHeading(doc,0);
         hyperlink.apply();

### hyperLinkSpreadsheet

    public void hyperLinkSpreadsheet(java.lang.String useText)

  超链到电子表格文档。

  Parameters:
    `useText` - 要链接到的单元格引用或单元格名称

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         WpHyperlinkAttribute hyperlink = baseText.getHyperlink(0,2);
         hyperlink.setHyperlinkType(1);
         hyperlink.setShowText("aa");
         hyperlink.setScreenTip("myAA");
         hyperlink.hyperLinkSpreadsheet("工作表2!A2:2");
         hyperlink.apply();

### hyperlinkToCustomShowList

    public void hyperlinkToCustomShowList(Presentation pg,
                                          java.lang.String listName)

  设置超链接到简报制作应用中的自定义播放列表。

  Parameters:
    `pg` - 包含所要链接自定义列表的简报制作应用类
    `listName` - 自定义播放列表名称

    例子：

         Application.gotoProduct(2);
         Presentation pg = Application.getWorkbooks().getActiveWorkbook().getPresentation("简报1");
         Application.gotoProduct(1);
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         WpHyperlinkAttribute hyperlink = baseText.getHyperlink(0,2);
         hyperlink.setHyperlinkType(1);
         hyperlink.setShowText("aa");
         hyperlink.setScreenTip("myAA");
         hyperlink.hyperlinkToCustomShowList(pg,"play1");
         hyperlink.apply();

### hyperlinkToCustomShowList

    public void hyperlinkToCustomShowList(java.lang.String appName,
                                          java.lang.String listName)

  设置超链接到简报制作应用中的自定义播放列表。

  Parameters:
    `appName` - 包含所要链接自定义列表的简报制作应用类
    `listName` - 自定义播放列表名称

    例子：

         Application.gotoProduct(2);
         Presentation pg = Application.getWorkbooks().getActiveWorkbook().getPresentation("简报1");
         Application.gotoProduct(1);
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         WpHyperlinkAttribute hyperlink = baseText.getHyperlink(0,2);
         hyperlink.setHyperlinkType(1);
         hyperlink.setShowText("aa");
         hyperlink.setScreenTip("myAA");
         hyperlink.hyperlinkToCustomShowList("简报1","play1");
         hyperlink.apply();

### hyperLinkTopOfDocumnet

    public void hyperLinkTopOfDocumnet(Document document)

  设置超链接到文档顶部。

  Parameters:
    `document` - 文字处理文档对象

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         WpHyperlinkAttribute hyperlink = baseText.getHyperlink(0,2);
         hyperlink.setHyperlinkType(1);
         hyperlink.setShowText("aa");
         hyperlink.setScreenTip("myAA");
         hyperlink.hyperLinkTopOfDocumnet(doc);
         hyperlink.apply();

### hyperlinkToSlide

    public void hyperlinkToSlide(Presentation pg,
                                 int slideIndex)

  设置超链接到简报制作文档中的某一幻灯片。

  Parameters:
    `pg` - 包含所要链接幻灯片的简报制作应用类
    `slideIndex` - 幻灯片索引号

    例子：

         Application.gotoProduct(2);
         Presentation pg = Application.getWorkbooks().getActiveWorkbook().getPresentation("简报1");
         Application.gotoProduct(1);
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         WpHyperlinkAttribute hyperlink = baseText.getHyperlink(0,2);
         hyperlink.setHyperlinkType(1);
         hyperlink.setShowText("aa");
         hyperlink.setScreenTip("myAA");
         hyperlink.hyperlinkToSlide(pg,0);
         hyperlink.apply();

### hyperlinkToSlide

    public void hyperlinkToSlide(java.lang.String appName,
                                 int slideIndex)

  设置链接到简报制作应用中的某一幻灯片。

  Parameters:
    `appName` - 简报制作文档名称
    `slideIndex` - 幻灯片索引号

    例子：

         Application.gotoProduct(2);
         Presentation pg = Application.getWorkbooks().getActiveWorkbook().getPresentation("简报1");
         Application.gotoProduct(1);
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         WpHyperlinkAttribute hyperlink = baseText.getHyperlink(0,2);
         hyperlink.setHyperlinkType(1);
         hyperlink.setShowText("aa");
         hyperlink.setScreenTip("myAA");
         hyperlink.hyperlinkToSlide("简报1",0);
         hyperlink.apply();

### setEmailAddress

    public void setEmailAddress(java.lang.String email)

  设置需要超链的邮件地址（仅对电子邮件有效)。

  Parameters:
    `email` - 邮件的地址

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         WpHyperlinkAttribute hyperlink = baseText.getHyperlink(0,5);
         hyperlink.setHyperlinkType(3);
         hyperlink.setEmailAddress("userName@wx88.net");
         hyperlink.apply();

### setEmailSubject

    public void setEmailSubject(java.lang.String subject)

  设置需要超链的邮件主题（仅对电子邮件有效)。

  Parameters:
    `subject` - 邮件的主题

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         WpHyperlinkAttribute hyperlink = baseText.getHyperlink(0,5);
         hyperlink.setHyperlinkType(3);
         hyperlink.setEmailAddress("userName@wx88.net");
         hyperlink.setEmailSubject("hello!");
         hyperlink.apply();

### setHyperlinkFileName

    public void setHyperlinkFileName(java.lang.String fileName)

  设置需要超链到文件或者网页（仅对原始的文件或网页有效)。

  Parameters:
    `fileName` - 文件名或者网页名

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         WpHyperlinkAttribute hyperlink = baseText.getHyperlink(0,5);
         hyperlink.setHyperlinkType(0);
         hyperlink.setHyperlinkFileName("d:/a.txt");
         hyperlink.apply();

### setHyperlinkType

    public void setHyperlinkType(int type)

  设置超链接的类型。

  Parameters:
    `type` - 超链接的类型

           0 - 表示原有的文件或网页；
           1 - 表示本文档中的位置；
           2 - 表示新建文档；
           3 - 表示邮件地址

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         WpHyperlinkAttribute hyperlink = baseText.getHyperlink(0,5);
         hyperlink.setHyperlinkType(0);
         hyperlink.setHyperlinkFileName("d:/a.txt");
         hyperlink.apply();

### setScreenTip

    public void setScreenTip(java.lang.String screenTip)

  设置超链接的屏幕提示。

  Parameters:
    `screenTip` - 屏幕提示字符串

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         WpHyperlinkAttribute hyperlink = baseText.getHyperlink(0,5);
         hyperlink.setHyperlinkType(0);
         hyperlink.setHyperlinkFileName("d:/a.txt");
         hyperlink.setScreenTip("tooltips");
         hyperlink.apply();

### setShowText

    public void setShowText(java.lang.Object showText)

  设置超链接的显示文本。

Overview | Package | Class | Tree | Index | Help

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

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