CAM API
  • CAM API
v20.0.1
Search Results for

    Show / Hide Table of Contents

    Interface ICamApiMacroManager

    Manages over all existing macros in the system

    Namespace: CAMAPI.Macros
    Assembly: CAMAPI.Macros.dll
    Syntax
    [Guid("4A341EB9-E7D2-4CA2-B906-6049914F3717")]
    [InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
    public interface ICamApiMacroManager

    Properties

    Application

    Reference to main Application object, which implements ICamAiApplication interface.

    Declaration
    object Application { get; set; }
    Property Value
    Type Description
    object

    Count

    Get count of macros in the system

    Declaration
    int Count { get; }
    Property Value
    Type Description
    int

    MacroBuilder

    Get singleton instance of macro builder

    Declaration
    ICamApiMacroBuilder MacroBuilder { get; }
    Property Value
    Type Description
    ICamApiMacroBuilder

    macro[int]

    Declaration
    ICamApiMacroInfo macro[int Index] { get; }
    Parameters
    Type Name Description
    int Index
    Property Value
    Type Description
    ICamApiMacroInfo

    Methods

    AddMacro(ICamApiMacroInfo, out TResultStatus)

    Declaration
    void AddMacro(ICamApiMacroInfo macro, out TResultStatus ret)
    Parameters
    Type Name Description
    ICamApiMacroInfo macro
    TResultStatus ret

    CreateMacroInstance()

    Create a new empty macro instance

    Declaration
    ICamApiMacroInfo CreateMacroInstance()
    Returns
    Type Description
    ICamApiMacroInfo

    Execute(string, string, out TResultStatus)

    Declaration
    void Execute(string Id, string Params, out TResultStatus ret)
    Parameters
    Type Name Description
    string Id
    string Params
    TResultStatus ret

    ExportMacro(string, string, out TResultStatus)

    Declaration
    void ExportMacro(string Id, string TargetPath, out TResultStatus ret)
    Parameters
    Type Name Description
    string Id
    string TargetPath
    TResultStatus ret

    GetMacroById(string)

    Get macro by its ident

    Declaration
    ICamApiMacroInfo GetMacroById(string Id)
    Parameters
    Type Name Description
    string Id
    Returns
    Type Description
    ICamApiMacroInfo

    ImportMacro(string, out TResultStatus)

    Declaration
    ICamApiMacroInfo ImportMacro(string SourcePath, out TResultStatus ret)
    Parameters
    Type Name Description
    string SourcePath
    TResultStatus ret
    Returns
    Type Description
    ICamApiMacroInfo

    NotifyMacroStep(int, out TResultStatus)

    Declaration
    void NotifyMacroStep(int stepIndex, out TResultStatus ret)
    Parameters
    Type Name Description
    int stepIndex
    TResultStatus ret

    OpenInEditor(ICamApiMacroInfo, out TResultStatus)

    Declaration
    void OpenInEditor(ICamApiMacroInfo macro, out TResultStatus ret)
    Parameters
    Type Name Description
    ICamApiMacroInfo macro
    TResultStatus ret

    RemoveMacro(string, bool, out TResultStatus)

    Declaration
    void RemoveMacro(string Id, bool DeleteSources, out TResultStatus ret)
    Parameters
    Type Name Description
    string Id
    bool DeleteSources
    TResultStatus ret
    In this article