2.4.843 BrtUserBookView
The BrtUserBookView record specifies the general custom view settings that apply to a whole workbook. There are accompanying BrtBeginUserShView (section 2.4.294) and BrtBeginUserCsView (section 2.4.291) records that specify individual custom view settings of each sheet. The set of this record and the accompanying BrtBeginUserShView and BrtBeginUserCsView records share the same GUID.
|
|
|
|
|
|
|
|
|
|
1 |
|
|
|
|
|
|
|
|
|
2 |
|
|
|
|
|
|
|
|
|
3 |
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
xLeft |
|||||||||||||||||||||||||||||||
|
xRight |
|||||||||||||||||||||||||||||||
|
yTop |
|||||||||||||||||||||||||||||||
|
yBot |
|||||||||||||||||||||||||||||||
|
iTabid |
|||||||||||||||||||||||||||||||
|
iTabRatio |
|||||||||||||||||||||||||||||||
|
guid (16 bytes) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
wMergeInterval |
A |
B |
C |
D |
E |
F |
G |
H |
I |
J |
K |
L |
M |
N |
|||||||||||||||||
|
O |
unused |
stName (variable) |
|||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
xLeft (4 bytes): A signed integer that specifies the X coordinate for the left side of the window that contains the workbook, relative to the left side of the workbook window. The unit of measurement for this value is twips.
xRight (4 bytes): A signed integer that specifies the X coordinate for the right side of the window that contains the workbook, relative to the left side of the workbook window. The unit of measurement for this value is twips.
yTop (4 bytes): A signed integer that specifies the Y coordinate for the top of the window that contains the workbook, relative to the top of the workbook window. The unit of measurement for this value is twips.
yBot (4 bytes): A signed integer that specifies the Y coordinate for the bottom of the window that contains the workbook, relative to the top of the workbook window. The unit of measurement for this value is twips.
iTabid (4 bytes): An unsigned integer that specifies the active sheet in this custom view. iTabid MUST be equal to the value of the iTabID in a BrtBundleSh (section 2.4.313) in this workbook. This field MUST be greater than or equal to one and less than or equal to 65535.
iTabRatio (4 bytes): An unsigned integer that specifies the ratio of the window area used to display sheet tabs and the window area used to display the horizontal scroll bar. iTabRatio MUST be greater than or equal to 0 and less than or equal to 1000. A value of 0 specifies that only the horizontal scroll bar is displayed. A value of 1000 specifies that only sheet tabs are displayed.
guid (16 bytes): A GUID as specified by [MS-DTYP] section 2.3.4 that specifies the identity of this custom view.
wMergeInterval (2 bytes): A signed integer that specifies the automatic-update interval in minutes. This field is undefined and MUST be ignored if fTimedUpdate equals 0. This field MUST be greater than or equal to 5 and less than or equal to 1440 when fTimedUpdate equals 1.
A - fIconic (1 bit): A bit that specifies whether the window that contains the workbook is minimized. fIconic and fZoom MUST NOT both be 1. This field MUST be one of the values specified in the following table.
-
Value
Meaning
0
The window that contains the workbook is not minimized.
1
The window that contains the workbook is minimized.
B - fDspHScroll (1 bit): A bit that specifies whether the horizontal scrollbar is displayed in the window that contains the workbook. This field MUST be one of the values specified in the following table.
-
Value
Meaning
0
Horizontal scrollbar is not displayed.
1
Horizontal scrollbar is displayed.
C - fDspVScroll (1 bit): A bit that specifies whether the vertical scrollbar is displayed in the window that contains the workbook. This field MUST be one of the values specified in the following table.
-
Value
Meaning
0
Vertical scrollbar is not displayed.
1
Vertical scrollbar is displayed.
-
D - fBotAdornment (1 bit): A bit that specifies whether sheet tabs are displayed in the window that contains the workbook. This field MUST be one of the values specified in the following table.
-
Value
Meaning
0
Sheet tabs are not displayed.
1
Sheet tabs are displayed.
E - fZoom (1 bit): A bit that specifies whether the window that contains the workbook is maximized. fIconic and fZoom MUST NOT both be 0x1. This field MUST be one of the values specified in the following table.
-
Value
Meaning
0
The window that contains the workbook is not maximized.
1
The window that contains the workbook is maximized.
F - fDspFmlaBar (1 bit): A bit that specifies whether the formula bar is displayed. This field MUST be one of the values specified in the following table.
-
Value
Meaning
0
Formula bar is not displayed.
1
Formula bar is displayed.
G - fDspStatus (1 bit): A bit that specifies whether the status bar is displayed. This field MUST be one of the values specified in the following table.
-
Value
Meaning
0
Status bar is not displayed.
1
Status bar is displayed.
H - mdDspNote (2 bits): An unsigned integer that specifies how comments are displayed in the window that contains the workbook. This field MUST be one of the values specified in the following table.:
-
Value
Meaning
0
Comments are not displayed in this custom view.
1
Comments are displayed in this custom view.
2
Comment indicators are displayed in the window that contains the workbook.
I - mdHideObj (2 bits): An unsigned integer that specifies whether ActiveX objects, OLE objects, and drawing objects are displayed in the window that contains the workbook. This field MUST be one of the values specified in the following table.:
-
Value
Meaning
0
ActiveX objects, OLE objects, and drawing objects are displayed in the window that contains the workbook.
1
Placeholders are displayed in place of ActiveX objects, OLE objects, and drawing objects in the window that contains the workbook.
2
ActiveX objects, OLE objects, and drawing objects are not displayed in the window that contains the workbook.
J - fPrintIncl (1 bit): A bit that specifies that custom print settings are included in this custom view. This field MUST be one of the values specified in the following table.
-
Value
Meaning
0
No custom print settings exist for this custom view.
1
Custom print settings exist in a BrtBeginUserShView (section 2.4.294) record that has a guid field value equal to the guid of this BrtUserBookView record.
Additionally, print titles and print areas are specified by BrtName (section 2.4.711) records, each of which has a name containing the guid of this BrtUserBookView, using the following form, where guid matches the value of guid with each occurrence of the characters left brace ("{"), right brace ("}"), and dash ("-") in guid replaced by an underscore ("_") character:
Print titles: Zguid.wvu.PrintTitles
Print area: Zguid.wvu.PrintArea
K - fRowColIncl (1 bit): A bit that specifies that hidden rows, hidden columns, or filter settings are included in this custom view. MUST be one of the following:
-
Value
Meaning
0
No hidden rows, hidden columns, or filter settings exist for this custom view.
1
Hidden rows, hidden columns, or filter settings exist in a BrtBeginUserShView (section 2.4.294) record that has a guid field value equal to the guid of this BrtUserBookView record.
Additionally, hidden rows and hidden columns are specified by BrtName records, each of which has a name containing the guid of this BrtUserBookView, using the following form, where guid matches the value of guid with each occurrence of the characters left brace ("{"), right brace ("}"), and dash ("-") in guid replaced by an underscore ("_") character:
Hidden rows: Zguid.wvu.Rows
Hidden columns: Zguid.wvu.Cols
Filter settings are also specified by BrtName records, each of which has a name containing the value of guid for this BrtUserBookView record, and by BrtBeginAFilter (section 2.4.8) in a BrtBeginUserShView (section 2.4.294) with a guid field value equal to the guid of this BrtUserBookView record, using the following form, where guid matches the value of guid with each occurrence of the characters left brace ("{"), right brace ("}"), and dash ("-") in guid replaced by an underscore ("_") character:
Range being filtered: Zguid.wvu.FilterData
Range containing filter criteria: Zguid.wvu.FilterCriteria
L - fTimedUpdate (1 bit): A bit that specifies whether changes to the workbook will be automatically saved and changes made to the workbook by other users will be automatically loaded at the interval specified by the wMergeInterval. This value MUST be 0 and MUST be ignored if fPersonalView equals 0. This field MUST be one of the values specified in the following table.
-
Value
Meaning
0
Changes to the shared workbook (section 2.2.12) will not be automatically saved or updated.
1
Changes to the shared workbook will be automatically saved and updated.
M - fAllMemChanges (1 bit): A bit that specifies that changes made to the workbook in the current session take precedence over conflicting changes that exist in the persisted version of the workbook when the current session is persisted to disk. This value MUST be 0 and MUST be ignored if fPersonalView equals 0. This field MUST be one of the values specified in the following table.
-
Value
Meaning
0
Changes to the current session do not take precedence.
1
Changes to the current session do take precedence.
N - fOnlySync (1 bit): A bit that specifies whether the workbook will only be synchronized at the interval specified by wMergeInterval. This value MUST be 0 and MUST be ignored if fPersonalView equals 0. This field MUST be one of the values specified in the following table.
-
Value
Meaning
0
Save changes from the current session and synchronize the shared workbook (section 2.2.12).
1
Only synchronize the shared workbook.
O - fPersonalView (1 bit): A bit that specifies that this custom view is a personal custom view for a shared workbook (section 2.2.12) user. A personal custom view specifies print and filter settings for a single user of a shared workbook. This field is undefined and MUST be ignored if this is not a shared workbook. This field MUST be one of the values specified in the following table.
-
Value
Meaning
0
This custom view is not a personal custom view.
1
This custom view is a personal custom view.
unused (15 bits): This value is undefined and MUST be ignored.
stName (variable): An XLWideString (section 2.5.169) that specifies the name of the custom view. The length of this field MUST be greater than or equal to 1 and less than or equal to 255 characters.