ArcObjects Library Reference (PublisherControls)  

IARPageLayout.Refresh Method

Redraws the page layout display area.

[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 ARPageLayout to be completely redrawn by sending a windows paint event. Use the Refresh method to ensure the ARPageLayout 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 ARPageLayout ensures the user of a ArcReaderControl application sees any new edits.

Specify whether to immediately redraw the ARPageLayout or whether to queue up the redraw to happen at some point in the immediate 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 ARPageLayout 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 ARPageLayout will be redrawn after every extent change.

Remarks

The Refresh method triggers the following events:

OnBeforeScreenDraw
OnAfterScreenDraw

See Also

IARPageLayout Interface