IServerDocumentView interface

The IServerDocumentView represents either the document view or one of the associated panel views in Altium Designer. This interface is inherited from the IServerView interface.

public interface IServerDocumentView : IServerView

Namespace: DXP · Assembly: Altium.SDK.Interfaces

Inherits: IExternalForm → IServerView

Derived: IMBA2_SDK_DocumentView, INexusDevicesView

Remarks

The IServerDocument interface contains IServerDocumentView interfaces, that is, a design document open in Altium Designer contains links to a document view and at least one panel view.

IServerView interface

IServerDocumentView interface

Methods

Method	Returns	Description
GetOwnerDocument	IServerDocument	The OwnerDocument property returns the IServerDocument interface that the IServerDocumentView itnerface is associated with.
PerformAutoZoom	void	This method forces a refresh or repaint of the document / panel view.
UpdateStatusBar	void	This method forces an update of the status bar when a string is submitted to the status bar.

GetOwnerDocument

The OwnerDocument property returns the IServerDocument interface that the IServerDocumentView itnerface is associated with. An IServerDocument container stores IServerDocumentView interfaces which represent a document or panel view.

IServerDocument GetOwnerDocument();

Returns: IServerDocument

Extension method of IServerDocumentViewHelper (using DXP;).

This read only property is supported by the GetOwnerDocument method.

This property returns the IServerDocument interface that the IServerDocumentView interface is associated with. An IServerDocument container stores IServerDocumentView interfaces which represent a document or panel view.

See also: IClient, IExternalForm

Examples: Extension_PCBToImage

PerformAutoZoom

This method forces a refresh or repaint of the document / panel view.

void PerformAutoZoom();

Returns: nothing (void)

See also: IClient

Examples: Extension_ModifySchWireColor

UpdateStatusBar

This method forces an update of the status bar when a string is submitted to the status bar.

void UpdateStatusBar();

Returns: nothing (void)

See also: IClient

Inherited members

• From IServerView: GetFavoritesViewState, GetIsPanel, GetViewName, ReceiveNotification, SetFavoritesViewState, ViewState
• From IExternalForm: FocusFirstTabStop, GetBounds, GetCaption, GetHandle, Hide, ParentWindowCreated, ParentWindowDestroyed, SetBounds, SetFocus, SetParentWindow, Show

Returned by

IClient.CurrentView, IServerDocument.GetSnippetView, IServerDocument.GetView, IServerDocument.GetViewByName, IServerModule.CreateServerDocView

Accepted by

IClient.AddViewToFavorites, ICommandGetState.GetState, ICommandLauncher.GetCommandState, ICommandLauncher.LaunchCommand, IEDMSItemEditorCommands.Command_LinkToReleaseVault, IEDMSItemEditorCommands.Command_ReleaseToVault, IEDesignDataCommands.Command_ConfigureInstalledVaults, IEDesignDataCommands.Command_FocusVault, IEDesignDataCommands.Command_RefreshCurrentView, IEDesignDataCommands.GetState_ConfigureInstalledVaults, IEDesignDataCommands.GetState_FocusVault, IEDesignDataCommands.GetState_RefreshCurrentView, IProcessLauncher.GetCommandState, IProcessLauncher.PostMessage, IProcessLauncher.SendMessage, IServerDocument.AddView, IServerDocument.CanCreateSnippet, IServerDocument.CreateSnippetFile, IServerDocument.PlaceSnippet, IServerModuleActionsSupport.SetServerDocumentView, Utils.MessageRouterGetCommandEnabled, Utils.MessageRouterGetCommandState, Utils.MessageRouterPostCommandToModule, Utils.MessageRouterSendCommandToModule

Examples

Used in the SDK examples: Ciiva, Ciiva, Extension_AddVariant, Extension_AddVariant, Extension_BOMManager, Extension_BOMManager, Extension_ChangeOutputJobFile, Extension_ChangeOutputJobFile, Extension_CreatePCBLib, Extension_CreatePCBLib, Extension_CreateProject, Extension_CreateProject.