placeholder_name property

StructuredDocumentTagRangeStart.placeholder_name property

Gets or sets Name of the BuildingBlock containing placeholder text.

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

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

Exceptions

exceptioncondition
RuntimeError (Proxy error(InvalidOperationException))Throw if BuildingBlock with this name BuildingBlock.name is not present in Document.glossary_document.

Examples

Shows how to get the properties of multi-section structured document tags.

doc = aw.Document(MY_DIR + 'Multi-section structured document tags.docx')
range_start_tag = doc.get_child_nodes(aw.NodeType.STRUCTURED_DOCUMENT_TAG_RANGE_START, True)[0].as_structured_document_tag_range_start()
range_end_tag = doc.get_child_nodes(aw.NodeType.STRUCTURED_DOCUMENT_TAG_RANGE_END, True)[0].as_structured_document_tag_range_end()
print('StructuredDocumentTagRangeStart values:')
print(f'\t|id: {range_start_tag.id}')
print(f'\t|title: {range_start_tag.title}')
print(f'\t|placeholder_name: {range_start_tag.placeholder_name}')
print(f'\t|is_showing_placeholder_text: {range_start_tag.is_showing_placeholder_text}')
print(f'\t|lock_content_control: {range_start_tag.lock_content_control}')
print(f'\t|lock_contents: {range_start_tag.lock_contents}')
print(f'\t|level: {range_start_tag.level}')
print(f'\t|node_type: {range_start_tag.node_type}')
print(f'\t|range_end: {range_start_tag.range_end}')
print(f'\t|color: {range_start_tag.color.to_argb()}')
print(f'\t|sdt_type: {range_start_tag.sdt_type}')
print(f'\t|flat_opc_content: {range_start_tag.word_open_xml}')
print(f'\t|tag: {range_start_tag.tag}\n')
print('StructuredDocumentTagRangeEnd values:')
print(f'\t|id: {range_end_tag.id}')
print(f'\t|node_type: {range_end_tag.node_type}')

See Also