ServerDocument class

No description yet.

public class ServerDocument : SupportService, IServerDocument, IServerDocument2

Namespace: DXP · Assembly: Altium.SDK

Implements: IServerDocument, IServerDocument2

Constructors

public ServerDocument(IServerModule argServerModule, string argKind, string argFileName);

Methods

Method	Returns	Description
AcquireDataFileHandle	void
AcquireFileOwnership	void
AddView	void
CanCreateSnippet	bool
CanPlaceSnippet	bool
CreateSnippetFile	bool
DocumentDirectoryChanged	void
DoFileLoad	bool
DoFileSave	bool
DoSafeChangeFileNameAndSave	bool
DoSafeFileSave	bool
Focus	void
GetBeingClosed	bool
GetCanClose	bool
GetContextHelpTopicName	string
GetCount	int
GetDisplayName	string
GetDocumentModifiedDate	double
GetFileModifiedDate	double
GetFileName	string
GetIsShown	bool
GetKind	string
GetModified	bool
GetOpenDocumentId	string
GetSupportsOwnSave	bool
Internal_GetServerModule	object
Internal_GetSnippetView	object
Internal_GetView	object
Internal_GetViewByName	object
NotifyViews	void
OwnsFile	bool
PlaceSnippet	void
ReleaseDataFileHandle	void
ReleaseFileOwnership	void
RemoveView	void
SetBeingClosed	void
SetDisplayName	void
SetFileModifiedDate	void
SetFileName	string
SetIsShown	void
SetModified	void
SupportsReload	bool
UpdateModifiedDate	void
WarnIfOwnedByOther	bool
ZoomSnippetContents	void

AcquireDataFileHandle

No description yet.

void AcquireDataFileHandle();

Returns: nothing (void)

AcquireFileOwnership

No description yet.

void AcquireFileOwnership();

Returns: nothing (void)

AddView

No description yet.

void AddView(object argView);

Parameter	Type	Passing
argView	object	value

Returns: nothing (void)

CanCreateSnippet

No description yet.

bool CanCreateSnippet(object argView, int argMode, bool argContextSensitive);

Parameter	Type	Passing
argView	object	value
argMode	int	value
argContextSensitive	bool	value

Returns: bool

CanPlaceSnippet

No description yet.

bool CanPlaceSnippet(string argSnippetPath);

Parameter	Type	Passing
argSnippetPath	string	value

Returns: bool

CreateSnippetFile

No description yet.

bool CreateSnippetFile(object argView, string argSnippetFilePath, int argMode, bool argContextSensitive);

Parameter	Type	Passing
argView	object	value
argSnippetFilePath	string	value
argMode	int	value
argContextSensitive	bool	value

Returns: bool

DocumentDirectoryChanged

No description yet.

void DocumentDirectoryChanged();

Returns: nothing (void)

DoFileLoad

No description yet.

bool DoFileLoad();

Returns: bool

DoFileSave

No description yet.

bool DoFileSave(string argKind);

Parameter	Type	Passing
argKind	string	value

Returns: bool

DoSafeChangeFileNameAndSave

No description yet.

bool DoSafeChangeFileNameAndSave(string argNewFileName, string argKind);

Parameter	Type	Passing
argNewFileName	string	value
argKind	string	value

Returns: bool

DoSafeFileSave

No description yet.

bool DoSafeFileSave(string argKind);

Parameter	Type	Passing
argKind	string	value

Returns: bool

Focus

No description yet.

void Focus();

Returns: nothing (void)

GetBeingClosed

No description yet.

bool GetBeingClosed();

Returns: bool

GetCanClose

No description yet.

bool GetCanClose();

Returns: bool

GetContextHelpTopicName

No description yet.

string GetContextHelpTopicName();

Returns: string

GetCount

No description yet.

int GetCount();

Returns: int

GetDisplayName

No description yet.

string GetDisplayName();

Returns: string

GetDocumentModifiedDate

No description yet.

double GetDocumentModifiedDate();

Returns: double

GetFileModifiedDate

No description yet.

double GetFileModifiedDate();

Returns: double

GetFileName

No description yet.

string GetFileName();

Returns: string

GetIsShown

No description yet.

bool GetIsShown();

Returns: bool

GetKind

No description yet.

string GetKind();

Returns: string

GetModified

No description yet.

bool GetModified();

Returns: bool

GetOpenDocumentId

No description yet.

string GetOpenDocumentId();

Returns: string

GetSupportsOwnSave

No description yet.

bool GetSupportsOwnSave();

Returns: bool

Internal_GetServerModule

No description yet.

object Internal_GetServerModule();

Returns: object

Internal_GetSnippetView

No description yet.

object Internal_GetSnippetView();

Returns: object

Internal_GetView

No description yet.

object Internal_GetView(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: object

Internal_GetViewByName

No description yet.

object Internal_GetViewByName(string argViewName);

Parameter	Type	Passing
argViewName	string	value

Returns: object

NotifyViews

No description yet.

void NotifyViews(object argNotification);

Parameter	Type	Passing
argNotification	object	value

Returns: nothing (void)

OwnsFile

No description yet.

bool OwnsFile();

Returns: bool

PlaceSnippet

No description yet.

void PlaceSnippet(string argSnippetAddress, object argView);

Parameter	Type	Passing
argSnippetAddress	string	value
argView	object	value

Returns: nothing (void)

ReleaseDataFileHandle

No description yet.

void ReleaseDataFileHandle();

Returns: nothing (void)

ReleaseFileOwnership

No description yet.

void ReleaseFileOwnership();

Returns: nothing (void)

RemoveView

No description yet.

void RemoveView(object argView);

Parameter	Type	Passing
argView	object	value

Returns: nothing (void)

SetBeingClosed

No description yet.

void SetBeingClosed(bool argValue);

Parameter	Type	Passing
argValue	bool	value

Returns: nothing (void)

SetDisplayName

No description yet.

void SetDisplayName(string argValue);

Parameter	Type	Passing
argValue	string	value

Returns: nothing (void)

SetFileModifiedDate

No description yet.

void SetFileModifiedDate(double argValue);

Parameter	Type	Passing
argValue	double	value

Returns: nothing (void)

SetFileName

No description yet.

string SetFileName(string argFileName);

Parameter	Type	Passing
argFileName	string	value

Returns: string

SetIsShown

No description yet.

void SetIsShown(bool argValue);

Parameter	Type	Passing
argValue	bool	value

Returns: nothing (void)

SetModified

No description yet.

void SetModified(bool argValue);

Parameter	Type	Passing
argValue	bool	value

Returns: nothing (void)

SupportsReload

No description yet.

bool SupportsReload();

Returns: bool

UpdateModifiedDate

No description yet.

void UpdateModifiedDate();

Returns: nothing (void)

WarnIfOwnedByOther

No description yet.

bool WarnIfOwnedByOther(int argWarningLevel);

Parameter	Type	Passing
argWarningLevel	int	value

Returns: bool

ZoomSnippetContents

No description yet.

void ZoomSnippetContents();

Returns: nothing (void)