ActionItemBaseTAction, TCollection Class

Information about an individual action that will be taken.

Definition

Namespace: ActionEngine
Assembly: ActionEngine (in ActionEngine.dll) Version: 26.2117.4453
C#
public abstract class ActionItemBase<TAction, TCollection>
where TAction : ActionItemBase<TAction, TCollection>
where TCollection : new(), ActionCollectionBase<TAction, TCollection>
Inheritance
Object    ActionItemBaseTAction, TCollection

Type Parameters

TAction
The implemented type of action.
TCollection
The implemented type of collection.

Constructors

ActionItemBaseTAction, TCollection Create a new instance of the ActionItemBase Item.

Properties

Action Get/Set the action associated with this entry.
Actions Get a reference to the collection of child SVG actions.
Base Get/Set the base number or filename pattern of the source or target files, depending upon the action.
Condition Get/Set the condition for flow control on this action.
ConfigFilename Get/Set the path and filename of the configuration file for this action.
Count Get/Set the count associated with the current action.
CurrentFile Get/Set a reference to the current active file in-use.
DataDir Get/Set the internal, calculated data directory.
DataFilename Get/Set the path and filename of the reference data file.
DataFiles Get a reference to the collection of file information used as reference data in this session.
DataNames Get a reference to the list of filenames or foldernames with or without wildcards. This parameter can be specified multiple times on the command line with different values to load multiple input files.
DateTimeValue Get/Set the date and time associated with the current action.
DefaultVariables Get a reference to the collection of default variables assigned to this action.
Digits Get/Set the number of digits associated with the current action.
Images Get a reference to the collection of images in this session.
InputDir Get/Set the internal, calculated input directory.
InputFilename Get/Set the input path and filename of the input file.
InputFiles Get a reference to the collection of file information used as input in this session.
InputFolderName Get/Set the path and folder name of the input for this action.
InputNames Get a reference to the list of filenames or foldernames with or without wildcards. This parameter can be specified multiple times on the command line with different values to load multiple input files.
Message Get/Set a message to be displayed when this action is run.
Options Get a reference to the collection of options assigned to this action.
OutputDir Get/Set the internal, calculated output directory.
OutputFile Get/Set the internal, calculated output file.
OutputFilename Get/Set the output path and filename for this action.
OutputFolderName Get/Set the output path and folder name for this action.
OutputName Get/Set an output pattern that allows for filenames or foldernames with or without wildcards. This parameter can be specified muliple times on the command line with different values to write to multiple output files.
Parent Get/Set a reference to the parent of this item.
Pattern Get/Set a regular expression pattern for files, folders, or other appropriate strings.
Properties Get a reference to the collection of properties assigned to this action.
Range Get/Set a reference to the start and end values of the range.
RecognizedActions Get a reference to the collection of recognized actions in this session.
Sequences Get a reference to the collection of sequences defined for this action.
SourceDir Get/Set the internal, calculated source directory.
SourceFolderName Get/Set the path and folder name of the data source for this action.
Stop Get/Set a value indicating whether the process should be stopped.
Text Get/Set the text of the current action.
VariableName Get/Set the name of the variable to access.
Variables Get a reference to the collection of variables on this instance.
WorkingDocument Get/Set the working key file for operations in this instance.
WorkingDocumentIndex Get/Set the input file index representing the working document.
WorkingImage Get/Set a reference to the current working image in this session.
WorkingPath Get/Set the working path for operations in this instance.

Methods

CheckElements Check all of the specified elements and return a value indicating whether the masked items were all valid.
ClearDataFiles Clear the local DataFiles collection for the immediate parent item.
ClearInputFiles Clear the local InputFiles collection for the immediate parent item.
DeserializeFile Deserialize the contents of the supplied file.
DrawImage Draw the image specified by ImageName onto the working image at the location specified by user properties Left and Top.
Equals
(Inherited from Object)
FileOpenImage Open the image specified in InputFilename.
FileOverlayImage Open each image from the range and place the image specified in InputFilename at the options specified by Left, Top, Width, and Height.
FileSaveImage Save the working image to the specified OutputFilename.
Finalize
(Inherited from Object)
ForEachFile Run the Actions collection of the presented object through all of the files in this item's InputFiles collection using the CurrentFile property for each one.
GetActionName Return the predefined version of the caller-supplied action name.
GetCurrentFile Return the current file.
GetHashCode
(Inherited from Object)
GetOptionByName Return the option specified by name from this or a parent entity.
GetPrecision Return the precision specified in the supplied item's Precision user property.
GetPropertyByName Return the user property specified by name from this or a parent entity.
GetSpecifiedOrWorking Return a reference either to the document specified in the local file arguments or the previously loaded working document.
GetType
(Inherited from Object)
GetVariable Get the value of the specified variable on the provided item instance.
IdentifyDataFiles Identify the data files at the current level for the specified item.
IdentifyInputFiles Identify the input and output files and directories at the current level for the specified item.
IdentifyOutputFiles Identify the output files and directories at the current level for the specified item.
If Run one or more sets of actions if their conditions are true.
ImageBackground Set the background color or image on the working image.
ImagesClear Clear the contents of the Images collection.
InitializeDefaultVariables Initialize the Variables property, in the specified item and all of its descendants, from the values in the corresponding DefaultVariables collections.
InitializeExpressionValues Initialize specialized expression values from the implemented instance.
InitializeFilenames Initialize values for working at this and child levels.
InitializeParent Initialize the Parent property in all of the decendants of the specified item.
InitializeProperties Initialize the public properties list of this class so they can be used repeatedly with minimal overhead.
InitializeVariable Initialize and return the supplied variable under preparation.
IsOutputLocal Return a value indicating whether the output filenames are local at this level.
MemberwiseClone
(Inherited from Object)
NormalizeValue Normalize the filename, using the values of any local properties necessary.
OpenWorkingDocument Open the working file to allow multiple operations to be completed in the same session.
Run Run the configured action.
RunActions Run all of the unmuted actions in the collection.
RunCustomAction Run a custom defined action.
RunSequence Run the specified sequence.
SaveWorkingDocument Save the working file to the specified output file.
SetVariable Set the value of the specified variable on the provided item instance.
SetWorkingImage Set the working image to the one specified by the user property ImageName.
ShouldSerializeAction Return a value indicating whether the Action property should be serialized.
ShouldSerializeActions Return a value indicating whether the Actions property should be serialized.
ShouldSerializeBase Return a value indicating whether the Base property should be serialized.
ShouldSerializeCondition Return a value indicating whether the Condition property should be serialized.
ShouldSerializeConfigFilename Return a value indicating whether the ConfigFilename property should be serialized.
ShouldSerializeCount Return a value indicating whether the Count property should be serialized.
ShouldSerializeDataFilename Return a value indicating whether the DataFilename property should be serialized.
ShouldSerializeDataNames Return a value indicating whether the DataNames property should be serialized.
ShouldSerializeDateTimeValue Return a value indicating whether the DateTimeValue property should be serialized.
ShouldSerializeDigits Return a value indicating whether the Digits property should be serialized.
ShouldSerializeInputFilename Return a value indicating whether the InputFilename property should be serialized.
ShouldSerializeInputFolderName Return a value indicating whether the InputFolderName property should be serialized.
ShouldSerializeInputNames Return a value indicating whether the InputNames property should be serialized.
ShouldSerializeMessage Return a value indicating whether the Message property should be serialized.
ShouldSerializeOptions Return a value indicating whether the Options property should be serialized.
ShouldSerializeOutputFilename Return a value indicating whether the OutputFilename property should be serialized.
ShouldSerializeOutputFolderName Return a value indicating whether the OutputFolderName property should be serialized.
ShouldSerializeOutputName Return a value indicating whether the OutputName property should be serialized.
ShouldSerializePattern Return a value indicating whether the Pattern property should be serialized.
ShouldSerializeProperties Return a value indicating whether the Properties property should be serialized.
ShouldSerializeRange Return a value indicating whether the Range property should be serialized.
ShouldSerializeSequences Return a value indicating whether the Sequences property should be serialized.
ShouldSerializeSourceFolderName Return a value indicating whether the SourceFolderName property should be serialized.
ShouldSerializeText Return a value indicating whether the Text property should be serialized.
ShouldSerializeVariableName Return a value indicating whether the VariableName property should be serialized.
ShouldSerializeWorkingDocumentIndex Return a value indicating whether the WorkingDocumentIndex property should be serialized.
ShouldSerializeWorkingPath Return a value indicating whether the WorkingPath property should be serialized.
SizeImage Scale the working image to a new size to the dimensions found in the Width and Height user properties.
ToString
(Inherited from Object)
WriteLocalOutput Write the local output from the specified action.

See Also