IServerPanelInfo interface

The IServerPanelInfo interface encapsulates the details of a panel in Altium Designer and the details can be Name, Bitmap, whether the panel can be docked horizontally or vertically and so on.

public interface IServerPanelInfo

Namespace: DXP · Assembly: Altium.SDK.Interfaces

Remarks

This interface is used by the IServerRecord interface and the IClient interface.

Methods

Method	Returns	Description
GetBitmap	string	The method returns the name of the bitmap.
GetButtonVisible	bool	The method returns whether the button on the panel is visible or not.
GetCanDockHorizontal	bool	This method determines whether the panel can be docked horizontally to the Altium Designer User Interface.
GetCanDockVertical	bool	This method determines whether the panel can be docked vertically to the Altium Designer User Interface.
GetCategory	string	This method returns the Category string, ie which module it is part of within Altium Designer.
GetCreationClassName	string	Internal use.
GetDocumentKindCount	int	This method reports how many document kinds this panel can be associated with.
GetDocumentKinds	string	This method returns the indexed Document Kind string that this panel is associated with.
GetHotkey	string	The method returns the HotKey string that is used to render the panel visible or not.
GetMultipleCreation	bool	Internal use.
GetName	string	This method returns the name of the panel.
GetProjectKindCount	int	Internal use.
GetProjectKinds	string	Internal use.
SupportsDocumentKind	bool	This method determines whether the document kind is supported by the panel.
SupportsProjectKind	bool	Internal use.

GetBitmap

The method returns the name of the bitmap.

string GetBitmap();

Returns: string

GetButtonVisible

The method returns whether the button on the panel is visible or not.

bool GetButtonVisible();

Returns: bool

GetCanDockHorizontal

This method determines whether the panel can be docked horizontally to the Altium Designer User Interface.

bool GetCanDockHorizontal();

Returns: bool

GetCanDockVertical

This method determines whether the panel can be docked vertically to the Altium Designer User Interface.

bool GetCanDockVertical();

Returns: bool

GetCategory

This method returns the Category string, ie which module it is part of within Altium Designer. For example the Favorites panel is part of the System.

string GetCategory();

Returns: string

GetCreationClassName

Internal use.

string GetCreationClassName();

Returns: string

GetDocumentKindCount

This method reports how many document kinds this panel can be associated with. For example with Simulation Breakpoints panel, it can be associated with VHDL and VHDTST documents.

int GetDocumentKindCount();

Returns: int

Use this method with the GetDocumentKinds method.

This property reports how many document kinds this panel can be associated with. For example with Simulation Breakpoints panel, it can be associated with VHDL and VHDTST documents.

Use this property with the DocumentKinds property.

GetDocumentKinds

This method returns the indexed Document Kind string that this panel is associated with. For example with Simulation Breakpoints panel, it can be associated with VHDL and VHDTST documents. This method is to be used in conjunction with the GetDocumentKindCount method.

string GetDocumentKinds(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: string

This property returns the indexed Document Kind string that this panel is associated with. For example with Simulation Breakpoints panel, it can be associated with VHDL and VHDTST documents. This property is to be used in conjunction with the GetDocumentKindCount method.

GetHotkey

The method returns the HotKey string that is used to render the panel visible or not.

string GetHotkey();

Returns: string

GetMultipleCreation

Internal use.

bool GetMultipleCreation();

Returns: bool

GetName

This method returns the name of the panel. For example the PCB Library panel has a PCBLibPanel name.

string GetName();

Returns: string

GetProjectKindCount

Internal use.

int GetProjectKindCount();

Returns: int

GetProjectKinds

Internal use.

string GetProjectKinds(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: string

SupportsDocumentKind

This method determines whether the document kind is supported by the panel.

bool SupportsDocumentKind(string argKind);

Parameter	Type	Passing
argKind	string	value

Returns: bool

SupportsProjectKind

Internal use.

bool SupportsProjectKind(string argKind);

Parameter	Type	Passing
argKind	string	value

Returns: bool

Returned by

IClient.GetPanelInfoByName, IServerRecord.GetPanelInfo, IServerRecord.GetPanelInfoByName