sub_address property

FieldHyperlink.sub_address property

Gets or sets a location in the file, such as a bookmark, where this hyperlink jumps.

@property
def sub_address(self) -> str:
    ...

@sub_address.setter
def sub_address(self, value: str):
    ...

Examples

Shows how to use HYPERLINK fields to link to documents in the local file system.

doc = aw.Document()
builder = aw.DocumentBuilder(doc)
field = builder.insert_field(aw.fields.FieldType.FIELD_HYPERLINK, True).as_field_hyperlink()
# When we click this HYPERLINK field in Microsoft Word,
# it will open the linked document and then place the cursor at the specified bookmark.
field.address = MY_DIR + 'Bookmarks.docx'
field.sub_address = 'MyBookmark3'
field.screen_tip = 'Open ' + field.address + ' on bookmark ' + field.sub_address + ' in a new window'
builder.writeln()
# When we click this HYPERLINK field in Microsoft Word,
# it will open the linked document, and automatically scroll down to the specified iframe.
field = builder.insert_field(aw.fields.FieldType.FIELD_HYPERLINK, True).as_field_hyperlink()
field.address = MY_DIR + 'Iframes.html'
field.screen_tip = 'Open ' + field.address
field.target = 'iframe_3'
field.open_in_new_window = True
field.is_image_map = False
doc.update_fields()
doc.save(ARTIFACTS_DIR + 'Field.field_hyperlink.docx')

sub_address property

FieldHyperlink.sub_address property

Examples

See Also