Zero Install .NET API 2.20.0
ZeroInstall.Model.ForEachArgs Class Reference

Expands an environment variable to multiple arguments. The variable specified in ItemFrom is split using Separator and the Arguments are added once for each item. More...

Inheritance diagram for ZeroInstall.Model.ForEachArgs:
ZeroInstall.Model.ArgBase ZeroInstall.Model.FeedElement NanoByte.Common.ICloneable< ArgBase > ZeroInstall.Model.XmlUnknown

Public Member Functions

override void Normalize ()
 Converts legacy elements, sets default values, etc.. More...
 
override string ToString ()
 Returns the for-each instruction in the form "ItemFrom". Not safe for parsing!
 
override ArgBase Clone ()
 Creates a deep copy of this ForEachArgs instance. More...
 
bool Equals (ForEachArgs? other)
 
override bool Equals (object? obj)
 
override int GetHashCode ()
 
- Public Member Functions inherited from ZeroInstall.Model.FeedElement
override int GetHashCode ()
 
- Public Member Functions inherited from ZeroInstall.Model.XmlUnknown
string ToShortXml ()
 Returns a shortened XML representation (with attributes but without child elements). More...
 
override int GetHashCode ()
 
- Public Member Functions inherited from NanoByte.Common.ICloneable< ArgBase >
ArgBase Clone ()
 

Properties

string ItemFrom = default! [getset]
 The name of the environment variable to be expanded.
 
string? Separator [getset]
 Overrides the default separator character (":" on POSIX and ";" on Windows).
 
List< ArgArguments = new() [get]
 A list of command-line arguments to be passed to an executable. "${item}" will be substituted with each for-each value.
 
- Properties inherited from ZeroInstall.Model.FeedElement
VersionRangeIfZeroInstallVersion [getset]
 Only process this element if the current Zero Install version matches the range.
 
string??? IfZeroInstallVersionString [getset]
 Used for XML serialization. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from ZeroInstall.Model.ArgBase
static implicit operator ArgBase (string value)
 Convenience cast for turning strings into plain Args.
 
- Public Attributes inherited from ZeroInstall.Model.XmlUnknown
XmlAttribute?[] UnknownAttributes
 Contains any unknown additional XML attributes.
 
XmlElement?[] UnknownElements
 Contains any unknown additional XML elements.
 
- Protected Member Functions inherited from ZeroInstall.Model.FeedElement
bool Equals (FeedElement? other)
 
- Protected Member Functions inherited from ZeroInstall.Model.XmlUnknown
void EnsureAttribute (object? value, string attributeName)
 Ensures that a value deserialized from an XML attribute is set (not null). More...
 
void EnsureAttributeSafeID (string? value, string attributeName)
 Ensures that a value deserialized from an XML attribute is set (not null) and only contains alphanumeric characters, spaces ( ), dots (.), underscores (_), hyphens (-) and plus signs (+). More...
 
bool Equals (XmlUnknown? other)
 
- Static Protected Member Functions inherited from ZeroInstall.Model.FeedElement
static bool FilterMismatch (IRecipeStep step)
 Checks whether an element passes the specified IfZeroInstallVersion restriction, if any.
 
- Static Package Functions inherited from ZeroInstall.Model.FeedElement
static bool FilterMismatch< T > (T element)
 Checks whether an element passes the specified IfZeroInstallVersion restriction, if any. More...
 

Detailed Description

Expands an environment variable to multiple arguments. The variable specified in ItemFrom is split using Separator and the Arguments are added once for each item.

Member Function Documentation

◆ Clone()

override ArgBase ZeroInstall.Model.ForEachArgs.Clone ( )
virtual

Creates a deep copy of this ForEachArgs instance.

Returns
The new copy of the ForEachArgs.

Implements ZeroInstall.Model.ArgBase.

◆ Normalize()

override void ZeroInstall.Model.ForEachArgs.Normalize ( )
virtual

Converts legacy elements, sets default values, etc..

Implements ZeroInstall.Model.ArgBase.


The documentation for this class was generated from the following file: