IServerWindowKind interface

This IServerWindowKind interface reports the type of a design document in Altium Designer and it is a composite object used in IServerRecord and IClient interface objects

public interface IServerWindowKind

Namespace: DXP · Assembly: Altium.SDK.Interfaces

Methods

Method	Returns	Description
FileExportDescriptionCount	int
FileImportDescriptionCount	int
FileLoadDescriptionCount	int	The method returns the number of File Load Descriptions for the document editor type of server.
FileSaveDescriptionCount	int	The method returns the number of File Save Descriptions for the document editor server.
GetFileExportDescription	string
GetFileImportDescription	string
GetFileLoadDescription	string	The method returns the indexed file load description.
GetFileSaveDescription	string	The method returns the indexed file save description.
GetIconName	string	The method returns the name of the icon associated with the server window of a document in DXP.
GetIsDocumentEditor	bool	The method returns a Boolean value whether this server is a document editor or not.
GetIsDomain	bool	The method returns the Boolean value for this Domain.
GetName	string	Returns the name of the window kind.
GetNewWindowCaption	string	The GetNewWindowCaption method returns the new document caption string for the new document in Altium Designer.
GetNewWindowExtension	string	The method returns the new document's extension string in DXP.
GetServerRecord	IServerRecord	Returns the IServerRecord interface that the IServerWindowKind interface is associated with.
GetWindowKindClass	string	The method returns the indexed window kind class.
GetWindowKindClassCount	int	The method returns the number of window kind classes.
GetWindowKindDescription	string	The method returns the window kind description string for a window in Altium Designer.
IsOfWindowKindClass	bool	The method returns a boolean value whether the class string is part of a window kind class or not.

FileExportDescriptionCount

No description yet.

int FileExportDescriptionCount();

Returns: int

FileImportDescriptionCount

No description yet.

int FileImportDescriptionCount();

Returns: int

FileLoadDescriptionCount

The method returns the number of File Load Descriptions for the document editor type of server. A document editor can support multiple document types and thus facilitate multiple load methods.

int FileLoadDescriptionCount();

Returns: int

See also: IClient

FileSaveDescriptionCount

The method returns the number of File Save Descriptions for the document editor server. A document editor can have multiple document types and thus have multiple corresponding file save methods.

int FileSaveDescriptionCount();

Returns: int

See also: IClient

GetFileExportDescription

No description yet.

string GetFileExportDescription(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: string

GetFileImportDescription

No description yet.

string GetFileImportDescription(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: string

GetFileLoadDescription

The method returns the indexed file load description. To be used in conjunction with the FileLoadDescriptionCount method.

string GetFileLoadDescription(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: string

See also: IClient

GetFileSaveDescription

The method returns the indexed file save description. To be used in conjunction with the FileSaveDescriptionCount method.

string GetFileSaveDescription(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: string

See also: IClient

GetIconName

The method returns the name of the icon associated with the server window of a document in DXP.

string GetIconName();

Returns: string

See also: IClient

GetIsDocumentEditor

The method returns a Boolean value whether this server is a document editor or not. Addons are not document editors. A document editor is a server that hosts its own documents and provide editing facilities. For example the PCB Editor is a Document Editor.

bool GetIsDocumentEditor();

Returns: bool

See also: IClient

GetIsDomain

The method returns the Boolean value for this Domain. Normally false.

bool GetIsDomain();

Returns: bool

See also: IClient

GetName

Returns the name of the window kind.

string GetName();

Returns: string

See also: IClient

GetNewWindowCaption

The GetNewWindowCaption method returns the new document caption string for the new document in Altium Designer.

string GetNewWindowCaption();

Returns: string

See also: IClient

GetNewWindowExtension

The method returns the new document's extension string in DXP.

string GetNewWindowExtension();

Returns: string

See also: IClient

GetServerRecord

Returns the IServerRecord interface that the IServerWindowKind interface is associated with. Since the server installation file defines document kinds (window kinds) and the IServerRecord interface represents this installation file.

IServerRecord GetServerRecord();

Returns: IServerRecord

Extension method of IServerWindowKindHelper (using DXP;).

See also: IClient

GetWindowKindClass

The method returns the indexed window kind class.

string GetWindowKindClass(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: string

See also: IClient

GetWindowKindClassCount

The method returns the number of window kind classes.

int GetWindowKindClassCount();

Returns: int

See also: IClient

GetWindowKindDescription

The method returns the window kind description string for a window in Altium Designer.

string GetWindowKindDescription();

Returns: string

See also: IClient

IsOfWindowKindClass

The method returns a boolean value whether the class string is part of a window kind class or not.

bool IsOfWindowKindClass(string argClass);

Parameter	Type	Passing
argClass	string	value

Returns: bool

See also: IClient

Returned by

IClient.GetWindowKindByName, IServerRecord.GetWindowKind, IServerRecord.GetWindowKindByName