VCOM:VectorWorks:Workspaces:IWorkspaceNavigationPalette::GetActivePanel

From Vectorworks Developer
Jump to navigation Jump to search

.SDK|SDK ..SDK:Types|SDK Types ..VCOM:VCOM (Vectorworks Component Object Model)|VCOM Basics ..VCOM:Class Reference|VCOM Class Reference

Description

namespace VectorWorks::Workspaces

Member of VCOM:VectorWorks:Workspaces:IWorkspaceNavigationPalette

Gets the active panel index.

virtual VCOMError VCOM_CALLTYPE GetActivePanel(
Sint16& outPanelIndex) = 0;

Parameters

outPanelIndex Sint16& Output parameter. Return the index of the panel that was saved as active.

Return Value

Uses standard VCOM Error Reporting.

Return value meaning:

kVCOMError_NotInitialized Bad VCOM instance used to call the fuction.
kVCOMError_Failed Routine failed.

Remarks

Panel index:

  • Class = 0
  • Layer = 1
  • Sheet Layer = 2
  • Viewport = 3
  • Saved View = 4