Provides access to members that control Screen Display. Note: the IScreenDisplay interface has been superseded byIScreenDisplay2. Please consider using the more recent version.
Product Availability
Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.
When To Use
The IScreenDisplay interface manages the display attributes of a screen. IScreenDisplay also handles other issues specific to windows including the backing store, scrolling, and invalidation.
Two objects currently implement IScreenDisplay, AppDisplay and ScreenDisplay. Each object's implementation of IScreenDisplay is slightly different; look at the help for a particular member for more details.
Members
Description | ||
---|---|---|
ActiveCache | Screen cache where drawing occurs. Use rarely. Change cache inside StartDrawing/FinishDrawing sequence. | |
AddCache | Creates a new cache and return its ID. The ID can be specified to StartDrawing to direct output to the cache. It can also be used with a number of other methods such as DrawCache and Invalidate. | |
CacheCount | Number of screen caches. | |
CacheMemDC | Memory device context for the specified screen cache. | |
CancelTracker | Cancel tracker that is associated with the display. | |
ClipEnvelope | The bounds of the invalid region. Use after StartDrawing and before FinishDrawing. | |
ClipEnvelopes | The invalid region as a set of envelopes. Use after StartDrawing and before FinishDrawing. | |
ClipGeometry | User-specified clip shape. This shape is merged with the invalid region to arrive at the actual clip region. Must be specified before StartDrawing. | |
DisplayTransformation | The transformation used by the display. | |
DoScroll | Scrolls the screen by the specified amount. | |
DrawCache | Draws the specified screen cache to the specified window device context. Pass an empty rectangle to copy the full bitmap to the DC origin. | |
DrawMultipoint | Draws specified multipoint on the display. | |
DrawPoint | Draws specified point on the display. | |
DrawPolygon | Draws specified polygon on the display. | |
DrawPolyline | Draws specified line on the display. | |
DrawRectangle | Draws specified rectangle on the display. | |
DrawText | Draws specified text on the display. | |
Filter | Display filter. Must call while in a StartDrawing-FinishDrawing sequence. Set Filter to 0 to resume normal drawing. | |
FinishDrawing | Completes drawing. | |
hDC | The device context that the display is currently drawing to. Only valid between calls to StartDrawing and FinishDrawing. | |
hPalette | Palette. | |
hWnd | Associated window handle. | |
IlluminationProps | Illumination properties used by the display. | |
Invalidate | Cause the specified area of the specified cache to redraw. | |
IsCacheDirty | Indicates if the specified cache needs refreshing. | |
IsFirstCacheTransparent | Indicates if the bottom cache is transparent. | |
IsFramed | Indicates if drawing occurs in a frame rather than on the whole window. | |
PanMoveTo | Pans to a new point. | |
PanStart | Prepares display for panning. | |
PanStop | Stops panning and returns new visible bounds. | |
Progress | Call frequently during drawing process. | |
RemoveAllCaches | Removes all caches. | |
RemoveCache | Removes the specified cache. | |
RotateMoveTo | Rotates to new point. | |
RotateStart | Prepares display for rotating. If centerPt is NULL, the center of the visible bounds is used. | |
RotateStop | Stops rotating and returns new angle. | |
RotateTimer | Draws the rotated display. Call in response to WM_TIMER. | |
ScaleContents | Indicates if the contents of the screen scale when a resize occurs. True means scale contents to fit new window size. False means contents stays the same with more or less of it showing. | |
SetScrollbarHandles | Optionally specify application supplied scrollbars. | |
SetSymbol | Sets the symbol used for drawing. Four different symbols can be specified simultaneously: Marker, Line, Fill, Text. | |
StartDrawing | Prepare the display for drawing. Specify the device context and the cache to draw to (normally esriNoScreenCache). The ScreenDisplay coclass will automatically create a window device context if you specify hdc = 0. | |
StartRecording | Starts recording all output to the recording cache. | |
StopRecording | Stops recording to the recording cache. | |
SuppressEvents | Indicates if display object suppresses events. | |
SuppressResize | Indicates if display resizing is suppressed. True means the display doesn't resize with the window. False ensures that the display is the same size as the window. | |
TrackPan | Interactively pans the screen. | |
TrackRotate | Interactively rotates the screen. | |
UpdateWindow | Forces a redraw. | |
UseScrollbars | Indicates if scrollbars should appear. | |
WindowDC | Device context for the associated window. Only use this between calls to StartDrawing and FinishDrawing. |
Inherited Interfaces
Interfaces | Description |
---|---|
IDisplay | Provides access to members that control the Display. |
CoClasses that implement IScreenDisplay
CoClasses and Classes | Description |
---|---|
AppDisplay (esriArcMapUI) | ESRI Display. |
GlobeDisplay (esriGlobeCore) | The globe display object. |
SceneGraph (esri3DAnalyst) | A container for recording data and events that occur in a scene. |
ScreenDisplay | Display class for drawing to window. |