screen_tip property

FieldAutoTextList.screen_tip property

Gets or sets the text of the ScreenTip to show.

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

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

Examples

Shows how to use an AUTOTEXTLIST field to select from a list of AutoText entries.

def field_auto_text_list():
    doc = aw.Document()
    # Create a glossary document and populate it with auto text entries.
    doc.glossary_document = aw.buildingblocks.GlossaryDocument()
    append_auto_text_entry(doc.glossary_document, 'AutoText 1', 'Contents of AutoText 1')
    append_auto_text_entry(doc.glossary_document, 'AutoText 2', 'Contents of AutoText 2')
    append_auto_text_entry(doc.glossary_document, 'AutoText 3', 'Contents of AutoText 3')
    builder = aw.DocumentBuilder(doc)
    # Create an AUTOTEXTLIST field and set the text that the field will display in Microsoft Word.
    # Set the text to prompt the user to right-click this field to select an AutoText building block,
    # whose contents the field will display.
    field = builder.insert_field(aw.fields.FieldType.FIELD_AUTO_TEXT_LIST, True).as_field_auto_text_list()
    field.entry_name = 'Right click here to select an AutoText block'
    field.list_style = 'Heading 1'
    field.screen_tip = 'Hover tip text for AutoTextList goes here'
    self.assertEqual(' AUTOTEXTLIST  "Right click here to select an AutoText block" ' + '\\s "Heading 1" ' + '\\t "Hover tip text for AutoTextList goes here"', field.get_field_code())
    doc.save(ARTIFACTS_DIR + 'Field.field_auto_text_list.dotx')

def append_auto_text_entry(glossary_doc: aw.buildingblocks.GlossaryDocument, name: str, contents: str):
    """Create an AutoText-type building block and add it to a glossary document."""
    building_block = aw.buildingblocks.BuildingBlock(glossary_doc)
    building_block.name = name
    building_block.gallery = aw.buildingblocks.BuildingBlockGallery.AUTO_TEXT
    building_block.category = 'General'
    building_block.behavior = aw.buildingblocks.BuildingBlockBehavior.PARAGRAPH
    section = aw.Section(glossary_doc)
    section.append_child(aw.Body(glossary_doc))
    section.body.append_paragraph(contents)
    building_block.append_child(section)
    glossary_doc.append_child(building_block)

screen_tip property

FieldAutoTextList.screen_tip property

Examples

See Also