2.4.198 BrtBeginSct

The BrtBeginSct record specifies properties of a scenario and specifies the beginning of a collection of BrtSlc (section 2.4.786) records as specified in the Worksheet part ABNF (section 2.1.7.62). The collection of BrtSlc records specifies the cells that are included in the scenario.


0


1


2


3


4


5


6


7


8


9

1
0


1


2


3


4


5


6


7


8


9

2
0


1


2


3


4


5


6


7


8


9

3
0


1

cref

fLocked

...

fHidden

...

Name (variable)

...

Comment (variable)

...

UserName (variable)

...

cref (2 bytes): An unsigned integer that specifies the count of BrtSlc records in the collection. This number MUST be greater than or equal to 1, MUST be equal to the count of cells in the scenario, and MUST be less than or equal to 32.

fLocked (4 bytes):  A Boolean (section 2.5.98.3) that specifies if the scenario is locked for editing when the sheet is protected. MUST be a value from the following table.

Value

Meaning

0x00000000

The scenario is not locked.

0x00000001

The scenario is locked.

If the sheet is protected and the fScenarios field in the BrtSheetProtectionIso (section 2.4.784) or BrtSheetProtection (section 2.4.783) record for this sheet is set to 1, then this setting is ignored.

fHidden (4 bytes):  A Boolean that specifies if the scenario is hidden when the sheet is protected and the fScenarios field in the BrtFileSharingIso (section 2.4.672) or BrtSheetProtection record for this sheet is set to 0. This value MUST be a value from the following table.

Value

Meaning

0x00000000

The scenario is not hidden.

0x00000001

The scenario is hidden.

If the scenario is marked as hidden but the fScenarios field in the BrtSheetProtectionIso (section 2.4.784) or BrtSheetProtection record for this sheet is set to 1, then this setting is ignored.

Name (variable): An XLWideString (section 2.5.169) that specifies the name of the scenario. This value MUST be unique across all BrtBeginSct in the Worksheet part, and MUST contain less than 256 characters.

Comment (variable): An XLWideString that specifies the comment for this scenario. This value MUST contain less than 256 characters. <19>

UserName (variable): An XLWideString that specifies the name of the user who last modified this scenario. This value MUST contain more than 1 character and less than 55 characters.