Formatting.BeginUpdate() Method
Locks the Formatting object by preventing visual updates until the EndUpdate method is called.
Namespace: DevExpress.Spreadsheet
Assembly: DevExpress.Spreadsheet.v19.1.Core.dll
Declaration
Remarks
The BeginUpdate and EndUpdate methods allow you to avoid flickering while performing batch modifications to the Formatting‘s settings. Once the BeginUpdate method has been called, modifying the Formatting‘s settings does not result in immediate repainting. So, multiple modifications can be made to the object without a major impact on performance or screen flickering. After all the desired operations have been finished, call the EndUpdate method.
The BeginUpdate and EndUpdate methods use an internal counter to implement the update functionality. The counter’s initial value is 0. Visual updates are forbidden if the counter’s value is greater than 0, and the updates are enabled if the counter’s value is 0. The BeginUpdate method increments the counter. The EndUpdate method decrements the counter. If the counter’s new value is 0, an immediate visual update occurs. Each call to BeginUpdate must be paired with a call to EndUpdate. To ensure that EndUpdate is always called even if an exception occurs, use the try…finally statement.
Example
- Access a style to be modified. To do this, get the corresponding Style object from the Workbook.Styles collection by the style name or index.
- Use the style’s
Formatting.BeginUpdateand Formatting.EndUpdate paired methods to modify the required format attributes of the style.
Note
A complete sample project is available at https://github.com/DevExpress-Examples/spreadsheet-document-server-api-e4339
// Access the style to be modified.
Style customStyle = workbook.Styles["Custom Style"];
// Change the required formatting characteristics of the style.
customStyle.BeginUpdate();
try {
customStyle.Fill.BackgroundColor = Color.Gold;
// ...
} finally {
customStyle.EndUpdate();
}