Eplan Platform API
EPLAN API / API Reference / Actions / XEGActionInsertSymRef
In This Topic
    XEGActionInsertSymRef
    In This Topic
     Standard action to find symbol references for inserting.
     
    

    Parameter Description
    SymbolLibName
    Name of the symbol library where the symbol is to find
    
    SymbolId
    Number of the symbol that should be inserted
    
    VariantId
    Number of the variant if the symbol has some
    
    FctDefTag
    Identifier of the function definition tag to search the symbol that should be inserted
    
    Placementmode
    Identifier of placement mode to search the symbol that should be inserted;
     string which defines the placement type of the symbol;
     the placement mode depends on the DocumentType
    
    SymbolType
    Identifier of symbol type to search the symbol that should be inserted
    
    CustomSymbols
    this parameter should be used if a user-created symbol should be inserted;
     the parameter is the name of the setting which contains the identifiers of the custom symbol;
     if this parameter is NOT empty, the custom symbol is used and not the symbol
     referenced by "SymbolLibName","SymbolId","VariantId";
     the setting must contains these values itself and must look like the following:
     XSbGui.CustomSymbols.CustomSymbols.lib
     XSbGui.CustomSymbols.CustomSymbols.id
     XSbGui.CustomSymbols.CustomSymbols.var
    

    Remarks
     This action works correctly only when gui is initialized. In case when symbol is not found window with symbols is opened.
     Can be used with all types of symbol variants, function definition tags, symbol data and symbol references.
     The action can be used only interactively.
     
    
    used specialized calling context: DMBaseHandleContext
    

    Example
     XEGActionInsertSymRef  /SymbolLibName:IEC_symbol /SymbolId:55 /VariantId:0