Skip to content

DeleteSymbolDefinition.md

Latest commit

 

History

History
42 lines (33 loc) · 1.12 KB

DeleteSymbolDefinition.md

File metadata and controls

42 lines (33 loc) · 1.12 KB
Raw

DeleteSymbolDefinition

Description

Procedure DeleteSymbolDefinition deletes the referenced symbol definition from the document. If bCompletely is TRUE, all corresponding symbol instances will be deleted completely; otherwise, the symbol instances will be replaced with loci.

PROCEDURE DeleteSymbolDefinition(
				hSymDef     : HANDLE;
				bCompletely : BOOLEAN);
def vs.DeleteSymbolDefinition(hSymDef, bCompletely):
    return None

Parameters

Name Type Description
hSymDef HANDLE Handle to the symbol definition.
bCompletely BOOLEAN Determines whether to replace the corresponding symbol instances with loci or delete the instances completely.

Examples

DeleteSymbolDefinition(hSymDef, TRUE);
import vs

# Procedure DeleteSymbolDefinition deletes the referenced symbol definition
# from the document.
hSymDef = vs.GetObject('MySymbol')  # handle to a symbol definition
bCompletely = True

vs.DeleteSymbolDefinition(hSymDef, bCompletely)

Version

Availability: from Vectorworks 2011

Category