Click or drag to resize

ScriptContextTryGetOrCreateField Method (String, ChoiceFieldItemType, FieldItem)

Gets or creates the field matching both the given name and choice type. A return value indicates an existing field with type was found or a new field instance was created successfully.

Namespace:  Compiled.EDD.Scripting
Assembly:  Compiled.EDD.Scripting (in Compiled.EDD.Scripting.dll) Version: 7.6.1.3-5cb5c356
Syntax
C#
Copy
public bool TryGetOrCreateField(
	string fieldName,
	ChoiceFieldItemType choiceFieldItemType,
	out FieldItem outputField
)

Parameters

fieldName
Type: SystemString
The name of the field.
choiceFieldItemType
Type: Compiled.EDD.ScriptingChoiceFieldItemType
The choice type of the field.
outputField
Type: Compiled.EDD.ScriptingFieldItem
When this method returns, contains the result of an existing or created field.

Return Value

Type: Boolean
true if a field with the name and choice type found, or created by this method; otherwise, false.

Implements

IScriptContextTryGetOrCreateField(String, ChoiceFieldItemType, FieldItem)
Exceptions
ExceptionCondition
ExceptionThrown when a matching field name exists but the choice type does not match the field type.
Remarks
Calls GetField(String) to check if the field exists, then checks if the ChoiceFieldItemType matches the existing field. When neither match, calls CreateField(String, ChoiceFieldItemType) to create a new field instance.
See Also