IExternalForm interface

This IExternalForm interface object has low level methods such as resizing and displaying the form.

public interface IExternalForm

Namespace: DXP · Assembly: Altium.SDK.Interfaces

Derived: IDocumentOptionsView, INavigatorView, IRevisionsView, IServerView, IToolchainManagerGenericOptionDlg, IInstrumentView, ILibraryReportExternalSettings

Remarks

For example VCL technology is not compatible with MS C++ toolkit.

Therefore to work with windows in the Altium Designer platform, you use the IExternalForm interface to have access to windows and manipulate them.

Methods

Method	Returns	Description
FocusFirstTabStop	void
GetBounds	void	This method retrieves the four bounds (left, top, width and height) of the form.
GetCaption	string
GetHandle	uint
Hide	void	This Hide method hides the form from view in Altium Designer.
ParentWindowCreated	void
ParentWindowDestroyed	void
SetBounds	void	This method sets the bounds of the external form.
SetFocus	void
SetParentWindow	void
Show	void	This method displays the hidden form.

FocusFirstTabStop

No description yet.

void FocusFirstTabStop();

Returns: nothing (void)

See also: IClient

Examples: Extension_ModifySchWireColor

GetBounds

This method retrieves the four bounds (left, top, width and height) of the form.

void GetBounds(ref int argLeft, ref int argTop, ref int argWidth, ref int argHeight);

Parameter	Type	Passing
argLeft	int	ref
argTop	int	ref
argWidth	int	ref
argHeight	int	ref

Returns: nothing (void)

See also: IClient

GetCaption

No description yet.

string GetCaption();

Returns: string

GetHandle

No description yet.

uint GetHandle();

Returns: uint

Hide

This Hide method hides the form from view in Altium Designer.

void Hide();

Returns: nothing (void)

See also: IClient

ParentWindowCreated

No description yet.

void ParentWindowCreated();

Returns: nothing (void)

See also: IClient

ParentWindowDestroyed

No description yet.

void ParentWindowDestroyed();

Returns: nothing (void)

See also: IClient

SetBounds

This method sets the bounds of the external form.

void SetBounds(int argLeft, int argTop, int argWidth, int argHeight);

Parameter	Type	Passing
argLeft	int	value
argTop	int	value
argWidth	int	value
argHeight	int	value

Returns: nothing (void)

See also: IClient

SetFocus

No description yet.

void SetFocus();

Returns: nothing (void)

See also: IClient

Examples: Extension_ModifySchWireColor

SetParentWindow

No description yet.

void SetParentWindow(IExternalFormHolder argParentWindow);
void SetParentWindow(object argParentWindow);

Parameter	Type	Passing
argParentWindow	IExternalFormHolder	value

Returns: nothing (void)

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

See also: IClient

Show

This method displays the hidden form.

void Show();

Returns: nothing (void)

See also: IClient

Examples: Extension_ModifySchWireColor

Returned by

INavigationDocument.GetDocumentScene, INavigationProvider.NavigateTo, INavigationSystem.NavigateTo, INavigationSystem.NavigateToScene, IWebAppHostModule.CreateSimpleBrowserForm, IWebAppHostModule.CreateWebBrowserScene, IModelEditor.GetExternalForm, ExternalFormComponent.GetExternalForm

Accepted by

INavigationProvider.NavigateTo, INavigationSystem.NavigateTo, INavigationSystem.NavigateToScene, IHighlightedModelEditor.DrawModel_PinsSelected, IHighlightedModelEditor.HighLightComponentPins, IHighlightedModelEditor.RegisterListener, IHighlightedModelEditor.ShowPinsAsSelected, IHighlightedModelEditor.ShowSpecifiedPinsOnly, IModelEditor.DrawModel, IModelEditor.DrawModel_FromModel, IModelEditor.DrawModel_FromSchImpl, IModelEditor.DrawModel_FromStepFile, IModelEditor2.Config, IModelEditor2.DrawModel_FromPCBPrimitive, ExternalFormComponent.SetExternalForm

Examples

Used in the SDK examples: Extension_NavigationProvider.