This document is archived and information here might be outdated.  Recommended version.


IARControl.Refresh Method (ArcObjects .NET 10.5 SDK)
ArcObjects Library Reference (PublisherControls)  

IARControl.Refresh Method

Refresh the control's window.

[Visual Basic .NET]
Public Sub Refresh ( _
    [ByVal refreshNow As Boolean] _
)
[C#]
public void Refresh (
    bool refreshNow
);
[C#]

Optional Values

refreshNow   Supply false as a default value.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Description

The Refresh method causes screen display area of the CurrentView to be completely redrawn by sending a windows paint event. This causes all data in the current map extent to be retieved and any map surround layout elements to be redrawn. Use the Refresh method to ensure the CurrentView is displaying the current state of the data. For example, if data is in an SDE server with many users editing the data, refreshing the CurrentView ensures the user of a ArcReaderControl application sees any new edits.

Specify whether to immediately redraw the CurrentView or whether to queue up the redraw to happen at some point in the future. For example, if there are many extent changes, but only the last extent needs displaying to the user pass False to the Refresh method. The paint event will be queued and the CurrentView will be redrawn once after the last extent change. However, if every extent change needs displaying to the user, pass True to the Refresh method. The CurrentView will be redrawn after every extent change. Likewise pass True after an extent change, but before flashing or flickering an ARFeature.

If the esriARWindows magnifier window if it is visible, the Refresh method will cause the contents of the window to be redrawn too.  

 

 

[C#]

When using the Refresh method from the host wrapper containing the instance of the ArcReaderControl on the Form the Refresh method has been renamed CtlRefresh. This is because there is already a member called Refresh defined within the .NET Framework.

[Visual Basic .NET]

When using the Refresh method from the host wrapper containing the instance of the ArcReaderControl on the Form the Refresh method has been renamed CtlRefresh. This is because there is already a member called Refresh defined within the .NET Framework.

See Also

IARControl Interface