AccessCacheOptions enumeration

AccessCacheOptions enumeration

Cache options for data access. Can be combined with | operator for multiple options together.

The AccessCacheOptions type exposes the following members:

Fields

FieldDescription
NONENo cache for any data access.
ALLApply all possible optimizations for all kinds of data access in the workbook.
All settings and data should not be changed during the optimized access.
POSITION_AND_SIZEApply possible optimization for getting object(such as Shape)’s position and size.
Row height and column width settings should not be changed during the optimized access.
CELLS_DATAApply possible optimization for getting cells’ values.
Cells data(data and settings of Cell, Row) should not be changed during
the optimized access, no new Cell/Row objects should be created either(such as
by [indexer]).
CELL_DISPLAYApply possible optimization for getting display-related results of
cells(Cell.display_string_value, Cell.get_style, Cell.get_display_style, etc.).
Cells data and style-related objects(Cell/Row/Column styles, column width, etc.) should not be changed
during the optimized access.
GET_FORMULAApply possible optimization for getting formulas.
All data and settings which may affect the formula expression(Worksheet’s name, Name’s text,
table’s column, etc.) should not be changed during the optimized access.
SET_FORMULAApply possible optimization for setting formulas.
All data and settings which may affect the formula expression(Worksheet’s name, Name’s text,
table’s column, etc.) should not be changed during the optimized access.
CALCULATE_FORMULAApply possible optimization for calculating formulas.
Cells data should not be changed during the optimized access, none new objects(Cell, Row, etc.)
should be created either(such as by [indexer]).
CONDITIONAL_FORMATTINGApply possible optimization for getting formatting result of conditional formattings.
All data and settings which may affect the result of conditional formattings(settings of
conditional formattings, dependent cell values, etc.) should not be changed during the optimized access.
VALIDATIONApply possible optimization for getting validation result.
All data and settings which may affect the result of validation(settings of the validation,
dependent cell values, etc.) should not be changed during the optimized access.

Remarks

For some features, accessing large dataset requires a lot of repeated and complicated operations such as search, calculation, …etc and those operations will take a lot of extra time. For common situations, all dependent data remains unchanged during the access, so some caches can be built and used to improve the access performance. For this purpose, we provide this API so that user can specify which kind of data access needs to be optimized by possible caching mechanism.

Please note, for different options, different data set may be required to be “read-only”. And performance of accessing data depends on many aspects, the use of caching mechanism does not guarantee that performance will be improved. For some situations, such as the dataset to be accessed is small, using cache may cause even more time because caching itself also needs certain extra time.

See Also