TGIS_ViewerWnd class

Main WinForms visual control for presenting, navigating, and interacting with Geographic Information System (GIS) maps in 2D and optional 3D modes.

Available also on: Delphi FMX | Java | ActiveX | Python.

Syntax

// C#
public class TGIS_ViewerWnd : Panel, IGIS_Viewer, IGIS_ViewerParent, IGIS_ViewerWnd 
{
}

' VisualBasic
Public Class TGIS_ViewerWnd
  Inherits Panel
  Implements IGIS_Viewer
  Implements IGIS_ViewerParent
  Implements IGIS_ViewerWnd
End Class

// Oxygene
type
  [ToolboxItem(True)]
  [ToolboxBitmap(typeOf(TGIS_ViewerWnd))]
  [Description('Window based map control.')]
  TGIS_ViewerWnd = public class( Panel, IGIS_Viewer, IGIS_ViewerParent, IGIS_ViewerWnd )
  end;

Inheritance

→ Panel

Implements

IGIS_Viewer IGIS_ViewerParent IGIS_ViewerWnd

Constructors

Inherited Overrides Protected

	Name	Visibility	Description
	TGIS_ViewerWnd()	public	Creates the windowed GIS viewer control and initializes its default interaction, rendering, and event-handling state.

Fields

Inherited Protected

Name	Visibility	Description
FOnAfterPaint	protected	Handler for the AfterPaint event, fired after any paint operation.
FOnAfterPaintRenderer	protected	Handler for the AfterPaintRenderer event, fired after any paint operation completes on the renderer.
FOnAfterUpdate	protected	Handler for the AfterUpdate event, fired after an update operation.
FOnBeforePaint	protected	Handler for the BeforePaint event, fired before any paint operation.
FOnBeforePaintRenderer	protected	Handler for the BeforePaintRenderer event, fired before any paint operation begins on the renderer.
FOnBeforeUpdate	protected	Handler for the BeforeUpdate event, fired before an update operation.
FOnEditorChange	protected	Handler for the EditorChange event.
FOnKeyDown	protected	Reintroduced KeyDown event.
FOnKeyPress	protected	Reintroduced KeyPress event.
FOnKeyUp	protected	Handler for the reintroduced KeyUp event.
FOnModeChange	protected	Handler for ModeChange event.
FOnPaintExtra	protected	Handler for the PaintExtra event, fired after the main draw operation completes.
FOnTapDouble	protected	Handler for the TapDouble event, fired for a double press and release gesture.
FOnTapLong	protected	Handler for the TapLong event, fired after a longer press gesture.
FOnTapSimple	protected	Handler for the TapSimple event, fired for a simple press and release gesture.
FOnUpdate	protected	Handler for the Update event, fired during an update operation.

Methods

Inherited Overrides Protected

Name	Visibility	Description
Add	public	Add a layer to the Viewer. _{(Implements IGIS_Viewer.Add)}
AddHierarchy	public	Read hierarchy information and build hierarchy groups with layers. _{(Implements IGIS_Viewer.AddHierarchy)}
AssignedBusyEvent	public	Reference to a busy event handler assigned to the Viewer. _{(Implements IGIS_Viewer.AssignedBusyEvent)}
AssignedHelpEvent	public	Reference to a help event handler assigned to the Viewer. _{(Implements IGIS_Viewer.AssignedHelpEvent)}
AttachLayer	public	Attach layer to the viewer by re-parenting. _{(Implements IGIS_Viewer.AttachLayer)}
BeginPaintInternal	public	Notify the viewer that painting is starting. _{(Implements IGIS_Viewer.BeginPaintInternal)}
BusyPrepare	public	Prepare BusyEvent for a long-running operation. _{(Implements IGIS_Viewer.BusyPrepare)}
BusyRelease	public	Release the busy state. _{(Implements IGIS_Viewer.BusyRelease)}
BusyShake	public	Update the busy state. _{(Implements IGIS_Viewer.BusyShake)}
CenterViewport	public	Sets the viewport so that _ptg becomes visible at the center of the screen. _{(Implements IGIS_Viewer.CenterViewport)}
ChangeHash	public	Change hash used to verify whether the layer order, parameters, or related viewer state has been modified. _{(Implements IGIS_Viewer.ChangeHash)}
Close	public	Close the current project. _{(Implements IGIS_Viewer.Close)}
ControlAutoCenterViewport	public	Move the screen origin of the map by delta values. _{(Implements IGIS_ViewerParent.ControlAutoCenterViewport)}
ControlCanvasHeight	public	Gets the canvas height. _{(Implements IGIS_ViewerParent.ControlCanvasHeight)}
ControlCanvasScale	public	Gets the canvas scale. _{(Implements IGIS_ViewerParent.ControlCanvasScale)}
ControlCanvasWidth	public	Gets the canvas width. _{(Implements IGIS_ViewerParent.ControlCanvasWidth)}
ControlClose	public	Notifies the control that the map is going to be closed. _{(Implements IGIS_ViewerParent.ControlClose)}
ControlDrawTexture(Object, TGIS_Extent, int)	public	Draws a texture. _{(Implements IGIS_ViewerParent.ControlDrawTexture)}
ControlDrawTexture(Object, TGIS_LayerAbstract, TGIS_Extent, int)	public	Draws a texture. _{(Implements IGIS_ViewerParent.ControlDrawTexture)}
ControlExtentChanged	public	Notify the control that the map extent has changed. _{(Implements IGIS_ViewerParent.ControlExtentChanged)}
ControlFlash	public	Flashes the control. _{(Implements IGIS_ViewerParent.ControlFlash)}
ControlHourglassHide	public	Hides the hourglass cursor. _{(Implements IGIS_ViewerParent.ControlHourglassHide)}
ControlHourglassShake	public	Shakes the hourglass cursor. _{(Implements IGIS_ViewerParent.ControlHourglassShake)}
ControlHourglassShow	public	Shows the hourglass cursor. _{(Implements IGIS_ViewerParent.ControlHourglassShow)}
ControlInvoke	public	Runs a procedure in the UI thread context. _{(Implements IGIS_ViewerParent.ControlInvoke)}
ControlObject	public	Returns the active control as an object. _{(Implements IGIS_ViewerParent.ControlObject)}
ControlPPI	public	Gets the current PPI. _{(Implements IGIS_ViewerParent.ControlPPI)}
ControlProcessMessages	public	Processes pending messages. _{(Implements IGIS_ViewerParent.ControlProcessMessages)}
ControlRaiseEditorChangeEvent	public	Raise the editor change event. _{(Implements IGIS_ViewerParent.ControlRaiseEditorChangeEvent)}
ControlRenderer	public	Gets the renderer instance. _{(Implements IGIS_ViewerParent.ControlRenderer)}
ControlRepaint	public	Repaints the control. _{(Implements IGIS_ViewerParent.ControlRepaint)}
ControlSet3DMode	public	Set the current 3D mode. _{(Implements IGIS_ViewerParent.ControlSet3DMode)}
ControlSystemPPI	public	Gets the system PPI. _{(Implements IGIS_ViewerParent.ControlSystemPPI)}
ControlUpdateBasemap	public	Updates the basemap. _{(Implements IGIS_ViewerParent.ControlUpdateBasemap)}
ControlUpdateEditor	public	Updates the editor. _{(Implements IGIS_ViewerParent.ControlUpdateEditor)}
ControlUpdateProgressive	public	Performs a progressive update. _{(Implements IGIS_ViewerParent.ControlUpdateProgressive)}
ControlUpdateSelection	public	Updates the selection layer. _{(Implements IGIS_ViewerParent.ControlUpdateSelection)}
ControlUpdateSynchronize	public	Wait for a pending paint operation to be finalized. _{(Implements IGIS_ViewerParent.ControlUpdateSynchronize)}
ControlUpdateTopmost	public	Updates the topmost layer. _{(Implements IGIS_ViewerParent.ControlUpdateTopmost)}
ControlUpdateWholeMap	public	Updates the whole map. _{(Implements IGIS_ViewerParent.ControlUpdateWholeMap)}
Delete	public	Delete the layer identified by a name. _{(Implements IGIS_Viewer.Delete)}
Dispose	public	Releases resources used by the control.
DoMouseDown	public	Executes the same operation as a mouse down event handler.
DoMouseMove	public	Executes the same operation as a mouse move event handler.
DoMouseUp	public	Executes the same operation as a mouse up event handler.
Draw	public	Draw all layers on the current renderer. _{(Implements IGIS_Viewer.Draw)}
EndPaintInternal	public	Notify the viewer that painting has finished. _{(Implements IGIS_Viewer.EndPaintInternal)}
FullExtent	public	Calculate the screen origin, zoom, and viewport to place the whole map in the window. _{(Implements IGIS_Viewer.FullExtent)}
FullExtentZoom	public	Calculates the zoom that fits the whole map inside the window. _{(Implements IGIS_Viewer.FullExtentZoom)}
Get	public	Retrieve the layer identified by name. _{(Implements IGIS_Viewer.Get)}
GetCacheBitmap	public	Returns a copy of the last cached bitmap used for viewer rendering.
GetGrid	public	Fill the provided _grid array with values for _extent. _{(Implements IGIS_Viewer.GetGrid)}
GetRenderContext	public	Returns the current rendering context object. _{(Implements IGIS_Viewer.GetRenderContext)}
GetViewer	public	Get the internal viewer handle. _{(Implements IGIS_ViewerParent.GetViewer)}
HourglassActive	public	Test whether the hourglass is active. _{(Implements IGIS_Viewer.HourglassActive)}
HourglassPrepare	public	Prepare the hourglass cursor for a long operation. _{(Implements IGIS_Viewer.HourglassPrepare)}
HourglassRelease	public	Release the hourglass state. _{(Implements IGIS_Viewer.HourglassRelease)}
HourglassRestart	public	Restart hourglass timing used for progressive updates. _{(Implements IGIS_Viewer.HourglassRestart)}
HourglassShake	public	Refresh the hourglass state. _{(Implements IGIS_Viewer.HourglassShake)}
Interrupt	public	Request interruption of a long-running operation as soon as possible. _{(Implements IGIS_Viewer.Interrupt)}
Interrupted	public	Test whether a pending operation must be aborted. _{(Implements IGIS_Viewer.Interrupted)}
InvalidateBasemap	public	Invalidate only basemap layers. _{(Implements IGIS_Viewer.InvalidateBasemap)}
InvalidateEditor	public	Invalidate the editor to mark the viewer for redraw after an editor change. _{(Implements IGIS_Viewer.InvalidateEditor)}
InvalidateExtent(TGIS_Extent)	public	Invalidate an extent for a full map redraw. _{(Implements IGIS_Viewer.InvalidateExtent)}
InvalidateExtent(TGIS_Extent, bool)	public	Invalidate an extent. _{(Implements IGIS_Viewer.InvalidateExtent)}
InvalidateSelection	public	Invalidate the selection to mark the viewer for redraw after a selection change. _{(Implements IGIS_Viewer.InvalidateSelection)}
InvalidateTopmost	public	Invalidate only topmost layers. _{(Implements IGIS_Viewer.InvalidateTopmost)}
InvalidateWholeMap	public	Invalidate whole map. _{(Implements IGIS_Viewer.InvalidateWholeMap)}
Locate(TGIS_Point, double)	public	Locates the shape nearest to _ptg that is within _prec. _{(Implements IGIS_Viewer.Locate)}
Locate(TGIS_Point, double, bool)	public	Locates the shape nearest to _ptg that is within _prec. _{(Implements IGIS_Viewer.Locate)}
Locate(TPoint, int)	public	Locates the shape nearest to _pt that is within _prec. _{(Implements IGIS_Viewer.Locate)}
LocateEx	public	Locates shapes on layers near _ptg and returns the best candidate from each layer that is within _prec. _{(Implements IGIS_Viewer.LocateEx)}
Lock	public	Lock the viewer. _{(Implements IGIS_Viewer.Lock)}
MapToScreen	public	Converts point coordinates from map coordinates to screen coordinates. _{(Implements IGIS_Viewer.MapToScreen)}
MapToScreen3D	public	Converts 3D point coordinates from map coordinates to screen coordinates. _{(Implements IGIS_Viewer.MapToScreen3D)}
MapToScreenEx	public	Converts point coordinates from map coordinates to screen coordinates, returning the result as TGIS_Point. _{(Implements IGIS_Viewer.MapToScreenEx)}
MapToScreenRect	public	Converts rectangle coordinates from map coordinates to screen coordinates. _{(Implements IGIS_Viewer.MapToScreenRect)}
MarkModified	public	Mark viewer upon some modifications. _{(Implements IGIS_Viewer.MarkModified)}
MoveViewport	public	Moves the map viewport by delta values in screen coordinates. _{(Implements IGIS_Viewer.MoveViewport)}
MoveViewportEx	public	Moves the map viewport by delta values in map coordinates. _{(Implements IGIS_Viewer.MoveViewportEx)}
MustSave	public	Check if any layer or the project file was modified by editing. _{(Implements IGIS_Viewer.MustSave)}
NotifyPaintException	public	Transform an exception into a TGIS_Viewer.OnPaintException event. _{(Implements IGIS_Viewer.NotifyPaintException)}
NotifySubscribers	public	Send a notification to subscribed controls. _{(Implements IGIS_Viewer.NotifySubscribers)}
OnTapDouble	protected	Execute the action equivalent to a double tap gesture.
OnTapLong	protected	Execute the action equivalent to a long tap gesture.
OnTapSingle	protected	Execute the action equivalent to a single tap gesture.
Open(string)	public	Open a project. _{(Implements IGIS_Viewer.Open)}
Open(string, bool)	public	Open a project. _{(Implements IGIS_Viewer.Open)}
OpenAsync(string, bool, TGIS_AsyncCallback)	public	Open a project asynchronously. _{(Implements IGIS_Viewer.OpenAsync)}
OpenAsync(string, TGIS_AsyncCallback)	public	Open a project asynchronously. _{(Implements IGIS_Viewer.OpenAsync)}
OpenEx(TGIS_ConfigAbstract, string)	public	Open a project file from memory. _{(Implements IGIS_Viewer.OpenEx)}
OpenEx(TGIS_ConfigAbstract, string, bool)	public	Open a project file from memory. _{(Implements IGIS_Viewer.OpenEx)}
OpenExAsync(TGIS_ConfigAbstract, string, bool, TGIS_AsyncCallback)	public	Open a project file from memory asynchronously. _{(Implements IGIS_Viewer.OpenExAsync)}
OpenExAsync(TGIS_ConfigAbstract, string, TGIS_AsyncCallback)	public	Open a project file from memory asynchronously. _{(Implements IGIS_Viewer.OpenExAsync)}
PixelsToTwips	public	Converts a size from device-dependent pixels to device-independent twips (1/1440 inch) to keep the map device independent. _{(Implements IGIS_Viewer.PixelsToTwips)}
Print	public	Print the current viewer content using the default printer. _{(Implements IGIS_ViewerWnd.Print)}
Print(IGIS_Printer)	public	Print the current viewer content using the specified printer. _{(Implements IGIS_ViewerWnd.Print)}
Print(PrintDocument)	public	Prints the current viewer content using the specified WinForms printer document.
PrintBmp(Bitmap)	public	Renders the current viewer content to a bitmap.
PrintBmp(Bitmap, bool)	public	Renders the current viewer content to a bitmap.
PrintBmp(Bitmap, Rectangle, TGIS_Extent, double)	public	Renders the current viewer content to a bitmap for a specified map extent.
PrintBmp(Bitmap, Rectangle, TGIS_Extent, double, bool)	public	Renders the current viewer content to a bitmap for a specified map extent.
PrintBmp(TGIS_Bitmap)	public	Print the current viewer content to a bitmap. _{(Implements IGIS_ViewerWnd.PrintBmp)}
PrintBmp(TGIS_Bitmap, bool)	public	Print the current viewer content to a bitmap. _{(Implements IGIS_ViewerWnd.PrintBmp)}
PrintClipboard	public	Copies the current viewer content to the clipboard.
PrintClipboard(bool)	public	Copies the current viewer content to the clipboard.
PrintPdf(string)	public	Prints the current extent to PDF using the default page size and default ppi. _{(Implements IGIS_Viewer.PrintPdf)}
PrintPdf(string, float, float)	public	Prints the current extent to PDF using the specified page size and default PPI. _{(Implements IGIS_Viewer.PrintPdf)}
PrintPdf(string, float, float, int)	public	Prints the current extent to PDF using the specified page size and custom PPI. _{(Implements IGIS_Viewer.PrintPdf)}
PrintPdf(TStream)	public	Prints the current extent to PDF using the default page size and default PPI. _{(Implements IGIS_Viewer.PrintPdf)}
PrintPdf(TStream, float, float)	public	Prints the current extent to PDF using the specified page size and default PPI. _{(Implements IGIS_Viewer.PrintPdf)}
PrintPdf(TStream, float, float, int)	public	Prints the current extent to PDF using the specified page size and custom PPI. _{(Implements IGIS_Viewer.PrintPdf)}
PrintSvg(string)	public	Prints the current extent to SVG (Scalable Vector Graphics) using the parent view box size and parent PPI. _{(Implements IGIS_Viewer.PrintSvg)}
PrintSvg(string, float, float, int)	public	Prints the current extent to SVG (Scalable Vector Graphics). _{(Implements IGIS_Viewer.PrintSvg)}
PrintSvg(TStream)	public	Prints the current extent to SVG (Scalable Vector Graphics) using the parent view box size and parent PPI. _{(Implements IGIS_Viewer.PrintSvg)}
PrintSvg(TStream, float, float, int)	public	Prints the current extent to SVG (Scalable Vector Graphics). _{(Implements IGIS_Viewer.PrintSvg)}
RaiseBusyEvent	public	Fire the viewer busy event. _{(Implements IGIS_Viewer.RaiseBusyEvent)}
RaiseHelpEvent	public	Fire the viewer help event. _{(Implements IGIS_Viewer.RaiseHelpEvent)}
ReadConfig	public	Read all configuration data from the project. _{(Implements IGIS_Viewer.ReadConfig)}
RecalcExtent	public	Calculates a common extent. _{(Implements IGIS_Viewer.RecalcExtent)}
ReParent	public	Set a new parent for the viewer. _{(Implements IGIS_Viewer.ReParent)}
ReParentLock	public	Block reparenting. _{(Implements IGIS_Viewer.ReParentLock)}
ReParentUnlock	public	Unblock reparenting. _{(Implements IGIS_Viewer.ReParentUnlock)}
Reposition	public	Reposition the map within the component window. _{(Implements IGIS_Viewer.Reposition)}
RereadConfig	public	Reread all configuration data from the project and layer configuration files. _{(Implements IGIS_Viewer.RereadConfig)}
RestorePaintState	public	Restore and free the current paint state. _{(Implements IGIS_Viewer.RestorePaintState)}
RevertAll	public	Revert all layers to a file-based original. _{(Implements IGIS_Viewer.RevertAll)}
RotatedExtent	public	Computes the extent that encompasses an extent after viewer rotation. _{(Implements IGIS_Viewer.RotatedExtent)}
RotatedPoint	public	Computes the position of a point after viewer rotation. _{(Implements IGIS_Viewer.RotatedPoint)}
RotatedPoint3D	public	Computes the position of a 3D point after viewer rotation. _{(Implements IGIS_Viewer.RotatedPoint3D)}
RotatedPoint3D_ref	public	Computes the position of the 3D point after viewer rotation. _{(Implements IGIS_Viewer.RotatedPoint3D_ref)}
SaveAll	public	Save all layers (parameters and data) _{(Implements IGIS_Viewer.SaveAll)}
SaveData	public	Save all changes to the data. _{(Implements IGIS_Viewer.SaveData)}
SaveProject	public	Save the current project. _{(Implements IGIS_Viewer.SaveProject)}
SaveProject(bool)	public	Save the current project. _{(Implements IGIS_Viewer.SaveProject)}
SaveProjectAs(string)	public	Save the current project under a new name. _{(Implements IGIS_Viewer.SaveProjectAs)}
SaveProjectAs(string, bool)	public	Save the current project under a new name. _{(Implements IGIS_Viewer.SaveProjectAs)}
SaveProjectAsEx(TGIS_ConfigAbstract, string)	public	Save the current project under a new name. _{(Implements IGIS_Viewer.SaveProjectAsEx)}
SaveProjectAsEx(TGIS_ConfigAbstract, string, bool)	public	Save the current project under a new name. _{(Implements IGIS_Viewer.SaveProjectAsEx)}
ScreenToMap	public	Converts point coordinates from screen coordinates to map coordinates. _{(Implements IGIS_Viewer.ScreenToMap)}
ScreenToMap3D	public	Converts point coordinates from screen coordinates to map coordinates. _{(Implements IGIS_Viewer.ScreenToMap3D)}
ScreenToMapEx	public	Converts point coordinates from screen coordinates to map coordinates, using TGIS_Point as the source type. _{(Implements IGIS_Viewer.ScreenToMapEx)}
ScreenToMapRect	public	Converts rectangle coordinates from screen coordinates to map coordinates. _{(Implements IGIS_Viewer.ScreenToMapRect)}
SetCSByEPSG	public	Sets the coordinate system from an EPSG (European Petroleum Survey Group) code. _{(Implements IGIS_Viewer.SetCSByEPSG)}
SetCSByWKT	public	Sets the coordinate system from a WKT (Well-Known Text) string containing a GEOGCS or PROJCS definition. _{(Implements IGIS_Viewer.SetCSByWKT)}
SetCSByWKTFile	public	Sets the coordinate system from a file containing a WKT (Well-Known Text) string with a GEOGCS or PROJCS definition. _{(Implements IGIS_Viewer.SetCSByWKTFile)}
SetViewer	public	Set the internal viewer handle. _{(Implements IGIS_ViewerParent.SetViewer)}
SetViewport	public	Sets the viewport origin to a given position in map coordinates. _{(Implements IGIS_Viewer.SetViewport)}
StorePaintState	public	Store the current paint state. _{(Implements IGIS_Viewer.StorePaintState)}
Subscribe	public	Add provided control to the notification subscription list. _{(Implements IGIS_Viewer.Subscribe)}
SynchronizePaint	public	Wait for a pending paint operation to finish. _{(Implements IGIS_Viewer.SynchronizePaint)}
TwipsToPixels	public	Converts a size from device-independent twips (1/1440 inch) to device-dependent pixels to keep the map device independent. _{(Implements IGIS_Viewer.TwipsToPixels)}
TwipsToPoints	public	Converts a size from device-independent twips (1/1440 inch) to device points for advanced font sizing. _{(Implements IGIS_Viewer.TwipsToPoints)}
Unlock	public	Unlock the viewer and redraw it. _{(Implements IGIS_Viewer.Unlock)}
Unlock(bool)	public	Unlock the viewer and optionally redraw it. _{(Implements IGIS_Viewer.Unlock)}
UnrotatedExtent	public	Computes the original extent of a rotated extent. _{(Implements IGIS_Viewer.UnrotatedExtent)}
UnrotatedPoint	public	Computes the original position of a rotated point. _{(Implements IGIS_Viewer.UnrotatedPoint)}
UnrotatedPoint3D	public	Computes the original position of a rotated 3D point. _{(Implements IGIS_Viewer.UnrotatedPoint3D)}
UnrotatedPoint3D_ref	public	Computes the original position of a rotated 3D point. _{(Implements IGIS_Viewer.UnrotatedPoint3D_ref)}
UnSubscribe	public	Remove provided control from the notification subscription list. _{(Implements IGIS_Viewer.UnSubscribe)}
WaitForBackgroundProcesses	public	Waits for any pending background processes that must finish before the application can continue. _{(Implements IGIS_Viewer.WaitForBackgroundProcesses)}
WaitForNotBusy	public	Calls _proc when the viewer fully finishes the painting process. _{(Implements IGIS_Viewer.WaitForNotBusy)}
WriteConfig	public	Write all configuration data to the project or layer INI file. _{(Implements IGIS_Viewer.WriteConfig)}
ZoomBy	public	Zoom the viewer. _{(Implements IGIS_ViewerWnd.ZoomBy)}

Properties

Inherited Protected

Name	Visibility	Description
AutoCenter	public	If True, the viewer automatically centers the map for operations such as clicking or editing that require the target location to be brought into view.
AutoStyle	public	If True, layers added to the viewer will have a unique style applied. _{(Implements IGIS_Viewer.AutoStyle)}
BackColor	public	Background color.
BigExtent	public	Map extent encompassing the collective extents of all layers and a border defined by BigExtentMargin. _{(Implements IGIS_Viewer.BigExtent)}
BigExtentMargin	public	Map extent margin. _{(Implements IGIS_Viewer.BigExtentMargin)}
BorderStyle	public	Border style of the control.
BusyLevel	public	Level of current busy state. _{(Implements IGIS_Viewer.BusyLevel)}
BusyText	public	Text related to the current busy state. _{(Implements IGIS_Viewer.BusyText)}
Center	public	Center the screen based on given point. _{(Implements IGIS_Viewer.Center)}
CenterPtg	public	Point on which the viewer will be centered during zoom. _{(Implements IGIS_Viewer.CenterPtg)}
Color	protected	Background color. _{(Implements IGIS_Viewer.Color)}
Copyright	public	Legal notice and product version. _{(Implements IGIS_Viewer.Copyright)}
CS	public	Coordinate system assigned to the viewer. _{(Implements IGIS_Viewer.CS)}
CursorFor3DSelect	public	Cursor for TGIS_Viewer3DMode.Select mode.
CursorForCameraPosition	public	Cursor for TGIS_Viewer3DMode.CameraPosition mode.
CursorForCameraRotation	public	Cursor for TGIS_Viewer3DMode.CameraRotation mode.
CursorForCameraXY	public	Cursor for TGIS_Viewer3DMode.CameraXY mode.
CursorForCameraXYZ	public	Cursor for TGIS_Viewer3DMode.CameraXYZ mode.
CursorForCameraZoom	public	Cursor for TGIS_Viewer3DMode.Zoom mode.
CursorForDrag	public	Cursor for TGIS_ViewerMode.Drag mode (dragging a map within the component window).
CursorForEdit	public	Cursor for TGIS_ViewerMode.Edit mode (editing a feature on a map).
CursorForSelect	public	Cursor for TGIS_ViewerMode.Select mode (selecting items on a map).
CursorForSunPosition	public	Cursor for TGIS_Viewer3DMode.SunPosition mode.
CursorForUserDefined	public	Cursor for TGIS_ViewerMode.UserDefined mode.
CursorForZoom	public	Cursor for TGIS_ViewerMode.Zoom mode (zooming a map using a rubber-band rectangle).
CursorForZoomEx	public	Cursor for TGIS_ViewerMode.ZoomEx mode (zooming a map interactively).
CustomData	public	List of custom user-defined data saved to and restored from config/project files. _{(Implements IGIS_Viewer.CustomData)}
CustomPPI	public	Custom resolution in pixels-per-inch. _{(Implements IGIS_Viewer.CustomPPI)}
DelayedUpdate	public	Delayed update threshold in milliseconds. _{(Implements IGIS_Viewer.DelayedUpdate)}
Editor	public	Editor context. _{(Implements IGIS_Viewer.Editor)}
Extent	public	Map extent encompassing the collective extents of all layers. _{(Implements IGIS_Viewer.Extent)}
FileCopyrights	public	List of copyrights. _{(Implements IGIS_Viewer.FileCopyrights)}
FontScale	public	Font magnifying factor in percents. _{(Implements IGIS_Viewer.FontScale)}
FullDrawExtent	public	Extent of the full current or last drawing area, including margin and without tiling. _{(Implements IGIS_Viewer.FullDrawExtent)}
Graticule	public	Graticule object.
Hierarchy	public	Hierarchy list. _{(Implements IGIS_Viewer.Hierarchy)}
IncrementalPaint	public	Is partial drawing to screen done in incremental mode? _{(Implements IGIS_Viewer.IncrementalPaint)}
InPaint	public	True if the viewer is busy in the Paint procedure. _{(Implements IGIS_Viewer.InPaint)}
IsBusy	public	Indicates whether the viewer is currently painting. _{(Implements IGIS_Viewer.IsBusy)}
IsEmpty	public	True if the viewer is empty and contains no layers. _{(Implements IGIS_Viewer.IsEmpty)}
IsLocked	public	True if the viewer is in the locked state. _{(Implements IGIS_Viewer.IsLocked)}
IsTopmost	public	True if Viewer has a topmost layer. _{(Implements IGIS_Viewer.IsTopmost)}
Items	public	All layers. _{(Implements IGIS_Viewer.Items)}
KeepScale	public	True if a viewer should maintain scale upon resize. _{(Implements IGIS_Viewer.KeepScale)}
LabelsReg	public	Labels position allocator object. _{(Implements IGIS_Viewer.LabelsReg)}
Level	public	Sets and gets the zoom level for the viewer. _{(Implements IGIS_Viewer.Level)}
MasterViewer	public	Reference to the master viewer used by tiled painting. _{(Implements IGIS_Viewer.MasterViewer)}
MinZoomSize	public	Minimum size of the zoom rectangle.
Mode	public	Mouse interaction mode for the viewer.
ModeMouseButton	public	Mouse button used for Mode operations such as dragging and selecting.
MultiUserMode	public	Multi-user mode. _{(Implements IGIS_Viewer.MultiUserMode)}
OverlappedExtentMargin	public	Overlapped extent margin in pixels. _{(Implements IGIS_Viewer.OverlappedExtentMargin)}
PPI	public	Rendering resolution in pixels per inch. _{(Implements IGIS_Viewer.PPI)}
ProgressiveUpdate	public	Progressive update threshold in milliseconds. _{(Implements IGIS_Viewer.ProgressiveUpdate)}
ProjectFile	public	Project file itself as opened in Open procedure. _{(Implements IGIS_Viewer.ProjectFile)}
ProjectName	public	Project file name as opened in Open procedure. _{(Implements IGIS_Viewer.ProjectName)}
Renderer	public	Currently active renderer.
RestrictedDrag	public	If True, dragging outside the map extent is not allowed. _{(Implements IGIS_Viewer.RestrictedDrag)}
RestrictedExtent	public	Restricted map extent. _{(Implements IGIS_Viewer.RestrictedExtent)}
RotationAngle	public	Angle of viewer rotation in radians. _{(Implements IGIS_Viewer.RotationAngle)}
RotationPoint	public	Point of viewer rotation in map units. _{(Implements IGIS_Viewer.RotationPoint)}
ScaleAsFloat	public	Sets and gets the scale factor. _{(Implements IGIS_Viewer.ScaleAsFloat)}
ScaleAsText	public	Sets and gets the scale factor as text in the format '1:10000'. _{(Implements IGIS_Viewer.ScaleAsText)}
SelectionColor	public	Color used to draw selected shapes and features.
SelectionGisColor	public	Color used to highlight selected objects. _{(Implements IGIS_Viewer.SelectionGisColor)}
SelectionOutlineOnly	public	If True, polygons are marked only with an outline and not filled. _{(Implements IGIS_Viewer.SelectionOutlineOnly)}
SelectionTransparency	public	Transparency value for selection. _{(Implements IGIS_Viewer.SelectionTransparency)}
SelectionWidth	public	Outline width of selection area (>0 in twips, <0 in pixels). _{(Implements IGIS_Viewer.SelectionWidth)}
SystemPPI	public	System resolution in pixels per inch. _{(Implements IGIS_Viewer.SystemPPI)}
TemporaryScaleInternal	public	Used to force rendering at a scale different from the actual scale. _{(Implements IGIS_Viewer.TemporaryScaleInternal)}
TemporaryVisibleExtent	public	Used to force label rendering while drawing with tiles. _{(Implements IGIS_Viewer.TemporaryVisibleExtent)}
TiledPaint	public	True if partial drawing to the screen is done in tiled mode. _{(Implements IGIS_Viewer.TiledPaint)}
UponDestroy	public	True if the viewer is being destroyed, so some operations such as screen updates should not be performed. _{(Implements IGIS_Viewer.UponDestroy)}
UseAnimations	public	True if zoom animations are allowed. _{(Implements IGIS_Viewer.UseAnimations)}
UseRTree	public	True if an RTree spatial index will be used by default when a layer is created. _{(Implements IGIS_Viewer.UseRTree)}
View3D	public	Indicates whether the viewer is operating in 3D mode.
Viewer3D	public	3D viewer object.
ViewerParent	public	Parent for the current IGIS_Viewer object. _{(Implements IGIS_Viewer.ViewerParent)}
ViewerParentRoot	public	Root parent for the current IGIS_Viewer object. _{(Implements IGIS_Viewer.ViewerParentRoot)}
Viewport	public	Sets and gets the upper-left corner position of the component window within the map. _{(Implements IGIS_Viewer.Viewport)}
VisibleExtent	public	Extent of the map visible in the window. _{(Implements IGIS_Viewer.VisibleExtent)}
Zoom	public	Sets and gets the relative zoom factor. _{(Implements IGIS_Viewer.Zoom)}
ZoomEx	public	Sets and gets the absolute zoom factor. _{(Implements IGIS_Viewer.ZoomEx)}

Events

Inherited Protected

Name	Visibility	Description
AfterPaintEvent	public	AfterPaint event.
AfterPaintRendererEvent	public	AfterPaintRenderer event.
AfterProjectOpenEvent	public	AfterProjectOpen event.
AfterUpdateEvent	public	AfterUpdate event.
BeforePaintEvent	public	BeforePaint event.
BeforePaintRendererEvent	public	BeforePaintRenderer event.
BeforeUpdateEvent	public	BeforeUpdate event.
BusyEvent	public	Busy event.
EditorChangeEvent	public	EditorChange event.
EditorPointChangeEvent	public	EditorPointChange event.
EditorPointMoveEvent	public	EditorPointMove event.
EditorSnapPointEvent	public	EditorSnapPoint event.
ExtentChangeEvent	public	ExtentChange event.
HelpEvent	public	Help event.
KeyDownEvent	public	Reintroduced handler for KeyDown.
KeyPressEvent	public	Reintroduced handler for KeyPress.
KeyUpEvent	public	Reintroduced handler for KeyUp.
LayerAddEvent	public	LayerAdd event.
LayerDeleteEvent	public	LayerDelete event.
ModeChangeEvent	public	Fired when the viewer mode changes.
PaintExceptionEvent	public	PaintException event.
PaintExtraEvent	public	PaintExtra event.
PasswordEvent	public	Password event.
ProjectCloseEvent	public	ProjectClose event.
ProjectOpenEvent	public	ProjectOpen event.
TapDoubleEvent	public	Fired when a double tap or double click completes.
TapLongEvent	public	Fired when a long press gesture is recognized.
TapSimpleEvent	public	Fired when a simple tap or click is recognized after pointer press and release.
UpdateEvent	public	Update event.
VisibleExtentChangeEvent	public	VisibleExtentChange event.
ZoomChangeEvent	public	ZoomChange event.

Remarks

PURPOSE: Provides the primary window-based viewer control for displaying GIS layers, handling user interaction, and managing map, project, and rendering state in a .NET WinForms application.

BEHAVIOR: Integrates the core viewer engine with WinForms paint and input events, supports multiple rendering paths including SharpDX and Skia, and coordinates redraw, caching, selection, editing, coordinate conversion, and optional 3D navigation.

CONSTRAINTS: This class is intended for window-based display. For bitmap output and off-screen rendering use TGIS_ViewerBmp instead. 3D functionality is available only when a valid IGIS_Viewer3D implementation is attached.

Available metadata keys:

Metadata	Values	Default	Description
TGIS_ViewerWnd.Paint.NavigateFeedback.FullCache	TRUE FALSE	TRUE	If true then all labels, selections, and topmost layers will be visible upon scaling, dragging etc.
TGIS_ViewerWnd.Paint.Progressive.Transparency	0..100	60	Long-term operations will be drawn as semitransparent.
TGIS_ViewerWnd.Paint.Progressive.FullCache	TRUE FALSE	TRUE	If true then long-term operations will be drawn behind last cached view.
TGIS_ViewerWnd.Paint.LabelsOnTop	TRUE FALSE	FALSE	If true then labels are drawn on top.
TGIS_ViewerWnd.Paint.Topmost.LabelsOnTop	TRUE FALSE	FALSE	If true then for topmost layers labels are drawn on top.

Available metadata keys:

Metadata	Values	Default	Description
TGIS_ViewerWnd.Paint.SharpDX.Full	TRUE FALSE	TRUE	If true then new behavior with full ShapeDX cacheing is enabled (DK-10535).
TGIS_ViewerWnd.Mode.Drag.AllGestures	TRUE FALSE	FALSE	If true then all gestures (pan and zoom) are enabled. If false then pan gesture simulates the mouse.
TGIS_ViewerWnd.Mode.Zoom.AllGestures	TRUE FALSE	FALSE	If true then all gestures (pan and zoom) are enabled. If false then pan gesture simulates the mouse.
TGIS_ViewerWnd.Mode.Select.AllGestures	TRUE FALSE	TRUE	If true then all gestures (pan and zoom) are enabled. If false then no gestures are enabled.
TGIS_ViewerWnd.Mode.Edit.AllGestures	TRUE FALSE	TRUE	If true then zoom gesture is enabled. If false then zoom gesture is disabled.
TGIS_ViewerWnd.Viewer3D.Mode.CameraPosition.AllGestures	TRUE FALSE	FALSE	If true then zoom gesture is enabled. If false then zoom gesture is disabled.
TGIS_ViewerWnd.Viewer3D.Mode.CameraXY.AllGestures	TRUE FALSE	FALSE	If true then zoom gesture is enabled. If false then zoom gesture is disabled.
TGIS_ViewerWnd.Viewer3D.Mode.CameraXYZ.AllGestures	TRUE FALSE	FALSE	If true then zoom gesture is enabled. If false then zoom gesture is disabled.
TGIS_ViewerWnd.Viewer3D.Mode.CameraRotation.AllGestures	TRUE FALSE	FALSE	If true then zoom gesture is enabled. If false then zoom gesture is disabled.
TGIS_ViewerWnd.Viewer3D.Mode.SunPosition.AllGestures	TRUE FALSE	FALSE	If true then zoom gesture is enabled. If false then zoom gesture is disabled.
TGIS_ViewerWnd.Viewer3D.Mode.Zoom.AllGestures	TRUE FALSE	FALSE	If true then all gestures (pan and zoom) are enabled. If false then pan gesture simulates the mouse.
TGIS_ViewerWnd.Viewer3D.Mode.Select.AllGestures	TRUE FALSE	TRUE	If true then all gestures (pan and zoom) are enabled. If false then no gestures are enabled.

TatukGIS Developer Kernel

Table of Contents

TGIS_ViewerWnd class

Syntax

Inheritance

Implements

Constructors

Fields

Methods

Properties

Events

Remarks

References

TatukGIS Developer Kernel

User Tools

Site Tools

Table of Contents

TGIS_ViewerWnd class

Syntax

Inheritance

Implements

Constructors

Fields

Methods

Properties

Events

Remarks

References

Page Tools