Skip to main content

IBomManager interface

No description yet.

public interface IBomManager

Namespace: EDP · Assembly: Altium.SDK.Interfaces

Methods​

MethodReturnsDescription
ExportSchemavoid
ExportSchemaEncodingvoid
GetAllowedSuppliersstring
GetAvailableCurrenciesstring
GetOptionsIBomManagerOptions
GetSchemaIBomSchema
Updatevoid
UpdateSchemavoid
UpdateSupplierDatavoid

ExportSchema​

No description yet.

void ExportSchema(string argExporterName, string argFileName);
ParameterTypePassing
argExporterNamestringvalue
argFileNamestringvalue

Returns: nothing (void)

ExportSchemaEncoding​

No description yet.

void ExportSchemaEncoding(string argExporterName, string argFileName, TBomExportEncoding argEncoding);
void ExportSchemaEncoding(string argExporterName, string argFileName, int argEncoding);
ParameterTypePassing
argExporterNamestringvalue
argFileNamestringvalue
argEncodingTBomExportEncodingvalue

Returns: nothing (void)

The first overload is an extension method of IBomManagerHelper (using EDP;) with typed parameters; the second is declared by the interface.

GetAllowedSuppliers​

No description yet.

string GetAllowedSuppliers();

Returns: string

GetAvailableCurrencies​

No description yet.

string GetAvailableCurrencies();

Returns: string

GetOptions​

No description yet.

IBomManagerOptions GetOptions();

Returns: IBomManagerOptions

Extension method of IBomManagerHelper (using EDP;).

Examples: Extension_BOMManager

GetSchema​

No description yet.

IBomSchema GetSchema();

Returns: IBomSchema

Extension method of IBomManagerHelper (using EDP;).

Examples: Extension_BOMManager

Update​

No description yet.

void Update(bool argDeferredUpdate, bool argUpdateSupplierData);
ParameterTypePassing
argDeferredUpdateboolvalue
argUpdateSupplierDataboolvalue

Returns: nothing (void)

UpdateSchema​

No description yet.

void UpdateSchema(bool argDeferredUpdate);
ParameterTypePassing
argDeferredUpdateboolvalue

Returns: nothing (void)

UpdateSupplierData​

No description yet.

void UpdateSupplierData();

Returns: nothing (void)

Returned by​

IBomManagerFactory.GetManagerForCompareDocuments, IBomManagerFactory.GetManagerForCompareSystemBoms, IBomManagerFactory.GetManagerForDocument, IBomManagerFactory.GetManagerForDocumentPcb, IBomManagerFactory.GetManagerForProject, IBomManagerFactory.GetManagerForProjectPcb

Examples​

Used in the SDK examples: Extension_BOMManager, Extension_BOMManager, Extension_BOMManager.