SequenceContext.GetMultipleValues
- Updated2025-07-21
- 2 minute(s) read
SequenceContext.GetMultipleValues
Syntax
SequenceContext.GetMultipleValues( lookupString, elem)
Return Value
Returns 0 if the value of the property element is the same for all steps in the context. If you pass in PropertyObjectElement_Flags for the elem parameter, the return value represents the bits of the PropertyFlags constant. A bit value is 0 if the flag value is the same for all steps.
Purpose
This method determines if the value of an element of a subproperty of multiple steps, such as the value, comment, format, or flags, represents the shared element value for all the steps in the array. Use this method with a SequenceContext that was created by passing an array of step references to the Engine.NewEditContext method, where the SequenceContext.Step property in the context contains the subset of properties all steps contain. This method returns zero if the Step subproperty element specified by lookupString and elem parameters has the same value for all steps.
Remarks
Use this method and the SequenceContext.SetMultipleValues method if you are writing a sequence editor in which you can select multiple steps. Display Multiple Values for an element when the value of the step property element is not the same.
You can create a SequenceContext with a Step property that represents multiple steps by calling the Engine.NewEditContext method and passing an array of object references to steps as the first parameter.
Parameters
lookupString As String
[In] Specifies the name of a subproperty within the SequenceContext you want to obtain the multiple values of. You can also pass lookup strings to this parameter.
elem As PropertyObjectElements
[In] Specifies the element of the subproperty that you want to obtain the multiple values of.