GetUpdateRectangle Method

Description

Returns the coordinates of the smallest rectangle that completely encloses the update region. When the document's visible part changes, a Changed event occurs and the changed part is added to the view's update region. The bValidate parameter can be used to reset the current update region to an empty rectangle. When the document's visible part changes because the document has been scrolled, the Changed event informs about the changed part, but it is not added to the update region.

Syntax

GetUpdateRectangle(bool)

Returns the coordinates of the smallest rectangle that completely encloses the update region. When the document's visible part changes, a Changed event occurs and the changed part is added to the view's update region. The bValidate parameter can be used to reset the current update region to an empty rectangle. When the document's visible part changes because the document has been scrolled, the Changed event informs about the changed part, but it is not added to the update region.

public Rectangle GetUpdateRectangle(bool bValidate);

Public Function GetUpdateRectangle(bValidate As Boolean) As Rectangle

GetUpdateRectangle(bool, out int, out int)

public Rectangle GetUpdateRectangle(bool bValidate, out int iFirstInvalidLine, out int iLastInvalidLine);

Public Function GetUpdateRectangle(bValidate As Boolean, ByRef iFirstInvalidLine As Integer, ByRef iLastInvalidLine As Integer) As Rectangle

Return Value

The return value specifies the smallest rectangle that completely encloses the current update region.

Examples

The following example retrieves update rectangle from the view.

var result = view.GetUpdateRectangle(true);
Console.WriteLine($"Get Update Rectangle result: {result}");

Dim result = view.GetUpdateRectangle(True)
Console.WriteLine($"Get Update Rectangle result: {result}")