Share via

2.2.5.5 CommandParameterFlags

  • Article

Namespace: http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/

Specifies various options to modify the behavior of operations.

 <xs:simpleType name="CommandParameterFlags" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:list>
     <xs:simpleType>
       <xs:restriction base="xs:string">
         <xs:enumeration value="ForceOneTimeRecalc"/>
         <xs:enumeration value="SuppressOneTimeRecalc"/>
         <xs:enumeration value="LogCpuTime"/>
         <xs:enumeration value="IsObjectModel"/>
         <xs:enumeration value="WantServerEvents"/>
         <xs:enumeration value="CanRegenerate"/>
         <xs:enumeration value="DoesNotCreatePrivateWorkbook"/>
         <xs:enumeration value="ConfirmationChoiceTrue"/>
       </xs:restriction>
     </xs:simpleType>
   </xs:list>
 </xs:simpleType>

The following table specifies the allowable values for the CommandParameterFlags simple type.

Value

Meaning

ForceOneTimeRecalc

If the current operation is a state changing operation the protocol server will calculate the workbook before returning the response.

SuppressOneTimeRecalc

The protocol server will not calculate the workbook before returning the response for the current operation.

LogCpuTime

MUST be ignored by the protocol server.

IsObjectModel

The protocol server allows editing of the workbook if the user has permissions to edit the workbook.

WantServerEvents

Specifies whether the protocol client receives information about server events that occurred during the processing of the command from the protocol server. If set, the protocol client MUST receive information about server events if they occurred during processing. If not set, the protocol client MUST NOT receive information about server events.

CanRegenerate

Specifies that if the current session (2) is created from GenerateWorkbookFromHtml and it times out that the protocol server MUST set the Id value of the ExcelServerMessage returned to the protocol client to either GeneratedWorkbookSessionTimeoutRecoverable or GeneratedWorkbookSessionTimeoutRegenerate. If not set, then if the current session (2) is created from GenerateWorkbookFromHtml and it times out, the protocol server MUST set the Id value of the ExcelServerMessage returned to the protocol client to either GeneratedWorkbookSessionTimeoutRecoverable or GeneratedWorkbookSessionTimeoutNonRecoverable. If the current session (2) is not created from GenerateWorkbookFromHtml, the protocol client MUST NOT set this value.

DoesNotCreatePrivateWorkbook

MUST NOT be used.

ConfirmationChoiceTrue

The external data refresh confirmation choice is true. See Confirmation.