IMBA_ServerDocument interface

No description yet.

public interface IMBA_ServerDocument : IServerDocument

Namespace: EDP · Assembly: Altium.SDK.Interfaces

Inherits: IServerDocument

Properties

Property	Type	Access	Description
Controller	IMBA_DocumentController	get
DataModel	IMBA_DocumentDataModel	get
DocumentID	int	get; set
UniqueID	string	get; set

Controller

No description yet.

IMBA_DocumentController GetState_Controller();

Type: IMBA_DocumentController · Access: read-only

The accessors are extension methods of IMBA_ServerDocumentHelper (using EDP;).

DataModel

No description yet.

IMBA_DocumentDataModel GetState_DataModel();

Type: IMBA_DocumentDataModel · Access: read-only

The accessors are extension methods of IMBA_ServerDocumentHelper (using EDP;).

DocumentID

No description yet.

int GetState_DocumentID();
void SetState_DocumentID(int argValue);

Type: int · Access: read/write

UniqueID

No description yet.

string GetState_UniqueID();
void SetState_UniqueID(string argValue);

Type: string · Access: read/write

Methods

Method	Returns	Description
GetPartBoundingBox	void
InvalidateDataModel	void
LoadPCBModel	IMBA_PartDataModel
LoadPCBModel_ForPreview	IMBA_PartDataModel
LoadStepModel	IMBA_PartDataModel
LoadStepModel_ForPreview	IMBA_PartDataModel
RemoveModel_ForPreview	bool
SetModelTransparent_ForPreview	void
SetPartVisible	void
ToggleMeasurementSystem	void
UpdateStepPartByStepPart_ForPreview	void

GetPartBoundingBox

No description yet.

void GetPartBoundingBox(int argPartId, out double argMinX, out double argMinY, out double argMinZ, out double argMaxX, out double argMaxY, out double argMaxZ);

Parameter	Type	Passing
argPartId	int	value
argMinX	double	out
argMinY	double	out
argMinZ	double	out
argMaxX	double	out
argMaxY	double	out
argMaxZ	double	out

Returns: nothing (void)

InvalidateDataModel

No description yet.

void InvalidateDataModel();

Returns: nothing (void)

LoadPCBModel

No description yet.

IMBA_PartDataModel LoadPCBModel(string argFileName);

Parameter	Type	Passing
argFileName	string	value

Returns: IMBA_PartDataModel

Extension method of IMBA_ServerDocumentHelper (using EDP;).

LoadPCBModel_ForPreview

No description yet.

IMBA_PartDataModel LoadPCBModel_ForPreview(string argFileName);

Parameter	Type	Passing
argFileName	string	value

Returns: IMBA_PartDataModel

Extension method of IMBA_ServerDocumentHelper (using EDP;).

LoadStepModel

No description yet.

IMBA_PartDataModel LoadStepModel(string argFileName, bool argNeedToCache);

Parameter	Type	Passing
argFileName	string	value
argNeedToCache	bool	value

Returns: IMBA_PartDataModel

Extension method of IMBA_ServerDocumentHelper (using EDP;).

LoadStepModel_ForPreview

No description yet.

IMBA_PartDataModel LoadStepModel_ForPreview(string argFileName);

Parameter	Type	Passing
argFileName	string	value

Returns: IMBA_PartDataModel

Extension method of IMBA_ServerDocumentHelper (using EDP;).

RemoveModel_ForPreview

No description yet.

bool RemoveModel_ForPreview(int argPartId);

Parameter	Type	Passing
argPartId	int	value

Returns: bool

SetModelTransparent_ForPreview

No description yet.

void SetModelTransparent_ForPreview(int argPartId, bool argTransparent);

Parameter	Type	Passing
argPartId	int	value
argTransparent	bool	value

Returns: nothing (void)

SetPartVisible

No description yet.

void SetPartVisible(int argPartId, bool argVisible);

Parameter	Type	Passing
argPartId	int	value
argVisible	bool	value

Returns: nothing (void)

ToggleMeasurementSystem

No description yet.

void ToggleMeasurementSystem();

Returns: nothing (void)

UpdateStepPartByStepPart_ForPreview

No description yet.

void UpdateStepPartByStepPart_ForPreview(IMBA_PartDataModel argDestStepPart, IMBA_PartDataModel argSourceStepPart);
void UpdateStepPartByStepPart_ForPreview(object argDestStepPart, object argSourceStepPart);

Parameter	Type	Passing
argDestStepPart	IMBA_PartDataModel	value
argSourceStepPart	IMBA_PartDataModel	value

Returns: nothing (void)

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

Inherited members

• From IServerDocument: AcquireDataFileHandle, AcquireFileOwnership, AddView, BeingClosed, CanCreateSnippet, CanPlaceSnippet, CreateSnippetFile, DocumentDirectoryChanged, DoFileLoad, DoFileSave, DoSafeChangeFileNameAndSave, DoSafeFileSave, FileModifiedDate, FileName, Focus, GetCanClose, GetContextHelpTopicName, GetCount, GetDocumentModifiedDate, GetKind, GetServerModule, GetSnippetView, GetSupportsOwnSave, GetView, GetViewByName, IsShown, Modified, NotifyViews, OwnsFile, PlaceSnippet, ReleaseDataFileHandle, ReleaseFileOwnership, SupportsReload, UpdateModifiedDate, WarnIfOwnedByOther, ZoomSnippetContents

Returned by

IMBA_ServerModule.CreateDocumentFromDataModel, IMBA_ServerModule.GetAssemblyByDocumentId, IMBA_ServerModule.GetAssemblyByPath, IMBA_ServerModule.LoadAssemblyByPath