IModelEditor interface

The IModelEditor interface represents the Model Editor hosted by a server which normally has a dialog that displays data about the model properties in Altium Designer. This IModelEditor interface is the front end for the actual implementation of a Model Editor for a specific model domain (PCB, Signal Integrity and other model types).

public interface IModelEditor

Namespace: SCH · Assembly: Altium.SDK.Interfaces

Derived: IHighlightedModelEditor

Methods

Method	Returns	Description
CreateDatafile	IModelDatafile
CreateServerModel	IServerModel
CrossProbeEntity	void
DrawModel	void
DrawModel_FromModel	bool
DrawModel_FromSchImpl	bool
DrawModel_FromStepFile	bool
DrawModelToMetaFile	void
EditModel	bool
EditModel_1	bool
EditModelMap	bool
FinishedLibraryCompile	void
GetEntityParameters	string
GetExternalForm	IExternalForm
PrepareModel	bool
SetDefaultModelState	bool
StartingLibraryCompile	void

CreateDatafile

No description yet.

IModelDatafile CreateDatafile(string argDatafilePath);

Parameter	Type	Passing
argDatafilePath	string	value

Returns: IModelDatafile

Extension method of IModelEditorHelper (using SCH;).

CreateServerModel

No description yet.

IServerModel CreateServerModel(IComponentImplementation argModel);

Parameter	Type	Passing
argModel	IComponentImplementation	value

Returns: IServerModel

Extension method of IModelEditorHelper (using SCH;).

CrossProbeEntity

No description yet.

void CrossProbeEntity(string argEntityName, string argDatafilePath);

Parameter	Type	Passing
argEntityName	string	value
argDatafilePath	string	value

Returns: nothing (void)

DrawModel

No description yet.

void DrawModel(IExternalForm argExternalForm, string argModelName, string argDatafilePath);
void DrawModel(object argExternalForm, string argModelName, string argDatafilePath);

Parameter	Type	Passing
argExternalForm	IExternalForm	value
argModelName	string	value
argDatafilePath	string	value

Returns: nothing (void)

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

DrawModel_FromModel

No description yet.

bool DrawModel_FromModel(IExternalForm argExternalForm, IModel argModel);
bool DrawModel_FromModel(object argExternalForm, object argModel);

Parameter	Type	Passing
argExternalForm	IExternalForm	value
argModel	IModel	value

Returns: bool

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

DrawModel_FromSchImpl

No description yet.

bool DrawModel_FromSchImpl(IExternalForm argExternalForm, ISch_Component argSchComp, ISch_Implementation argSchImpl);
bool DrawModel_FromSchImpl(object argExternalForm, object argSchComp, object argSchImpl);

Parameter	Type	Passing
argExternalForm	IExternalForm	value
argSchComp	ISch_Component	value
argSchImpl	ISch_Implementation	value

Returns: bool

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

DrawModel_FromStepFile

No description yet.

bool DrawModel_FromStepFile(IExternalForm argExternalForm, string argStepFilePath);
bool DrawModel_FromStepFile(object argExternalForm, string argStepFilePath);

Parameter	Type	Passing
argExternalForm	IExternalForm	value
argStepFilePath	string	value

Returns: bool

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

DrawModelToMetaFile

No description yet.

void DrawModelToMetaFile(string argFileName, string argModelName, string argDatafilePath, TPaintColorMode argPaintColorMode, TPaintScaleMode argPaintScaleMode);
void DrawModelToMetaFile(string argFileName, string argModelName, string argDatafilePath, int argPaintColorMode, int argPaintScaleMode);

Parameter	Type	Passing
argFileName	string	value
argModelName	string	value
argDatafilePath	string	value
argPaintColorMode	TPaintColorMode	value
argPaintScaleMode	TPaintScaleMode	value

Returns: nothing (void)

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

EditModel

No description yet.

bool EditModel(ISch_Implementation argSchModel, ISch_Component argSchComp, TModelEditContext argContext);
bool EditModel(object argSchModel, object argSchComp, int argContext);

Parameter	Type	Passing
argSchModel	ISch_Implementation	value
argSchComp	ISch_Component	value
argContext	TModelEditContext	value

Returns: bool

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

EditModel_1

No description yet.

bool EditModel_1(IModel argModel, IDItemRevision argDItemRevision, IAltiumLibrary argltiumLibrary);
bool EditModel_1(object argModel, object argDItemRevision, object argltiumLibrary);

Parameter	Type	Passing
argModel	IModel	value
argDItemRevision	IDItemRevision	value
argltiumLibrary	IAltiumLibrary	value

Returns: bool

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

EditModelMap

No description yet.

bool EditModelMap(IULB_ItemRevision argModelRevision, IEDMS_Vault argVault, ISch_Component argSchComp, ref string argMapAsString, ref string argExcludedParts);
bool EditModelMap(object argModelRevision, object argVault, object argSchComp, ref string argMapAsString, ref string argExcludedParts);

Parameter	Type	Passing
argModelRevision	IULB_ItemRevision	value
argVault	IEDMS_Vault	value
argSchComp	ISch_Component	value
argMapAsString	string	ref
argExcludedParts	string	ref

Returns: bool

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

FinishedLibraryCompile

No description yet.

void FinishedLibraryCompile();

Returns: nothing (void)

GetEntityParameters

No description yet.

string GetEntityParameters(string argEntityName, string argDatafilePath);

Parameter	Type	Passing
argEntityName	string	value
argDatafilePath	string	value

Returns: string

GetExternalForm

No description yet.

IExternalForm GetExternalForm();

Returns: IExternalForm

Extension method of IModelEditorHelper (using SCH;).

PrepareModel

No description yet.

bool PrepareModel(IComponentImplementation argModel);
bool PrepareModel(object argModel);

Parameter	Type	Passing
argModel	IComponentImplementation	value

Returns: bool

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

SetDefaultModelState

No description yet.

bool SetDefaultModelState(ISch_Implementation argSchModel, ISch_Component argSchComp, bool argIsLibrary);
bool SetDefaultModelState(object argSchModel, object argSchComp, bool argIsLibrary);

Parameter	Type	Passing
argSchModel	ISch_Implementation	value
argSchComp	ISch_Component	value
argIsLibrary	bool	value

Returns: bool

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

StartingLibraryCompile

No description yet.

void StartingLibraryCompile();

Returns: nothing (void)

Returned by

IModelType.Editor