Skip to main content
View as Markdown

IExternalFormHolder interface

The IExternalFormHolder interface represents the TExternalFormComponent object and holds the IExternalForm interface.

public interface IExternalFormHolder

Namespace: DXP · Assembly: Altium.SDK.Interfaces

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​

MethodReturnsDescription
GetParentWindowUIntPtrThis method retrieves the THandle of the parent window that can be used in the IExternalForm interface.
SetDialogHandlevoidThis method sets the dialog handle for this external form.
UpdateCaptionvoid

GetParentWindow​

This method retrieves the THandle of the parent window that can be used in the IExternalForm interface.

UIntPtr GetParentWindow();

Returns: UIntPtr

Extension method of IExternalFormHolderHelper (using DXP;).

SetDialogHandle​

This method sets the dialog handle for this external form.

void SetDialogHandle(UIntPtr argHandle);
void SetDialogHandle(object argHandle);
ParameterTypePassing
argHandleUIntPtrvalue

Returns: nothing (void)

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

UpdateCaption​

No description yet.

void UpdateCaption();

Returns: nothing (void)

Returned by​

ExternalForm.ParentWindow

Accepted by​

IExternalForm.SetParentWindow, ServerPanelForm.SetParentWindowHolder