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

Associates a Command with a user-friendly name and description. More...

Inheritance diagram for ZeroInstall.Model.EntryPoint:
ZeroInstall.Model.FeedElement ZeroInstall.Model.IIconContainer ZeroInstall.Model.ISummaryContainer NanoByte.Common.ICloneable< EntryPoint > ZeroInstall.Model.XmlUnknown ZeroInstall.Model.IDescriptionContainer

Public Member Functions

void Normalize ()
 Converts legacy elements, sets default values, etc.. More...
 
override string ToString ()
 Returns the EntryPoint in the form "Command (BinaryName)". Not safe for parsing!
 
EntryPoint Clone ()
 Creates a deep copy of this EntryPoint instance. More...
 
bool Equals (EntryPoint? 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< EntryPoint >
EntryPoint Clone ()
 

Properties

string Command = default! [getset]
 The name of the Command this entry point represents.
 
string? BinaryName [getset]
 The canonical name of the binary supplying the command (without file extensions). This is used to suggest suitable alias names. More...
 
string? AppId [getset]
 The Application User Model ID; used by Windows to associate shortcuts and pinned taskbar entries with running processes.
 
bool NeedsTerminal [getset]
 If true, indicates that the Command represented by this entry point requires a terminal in order to run.
 
bool SuggestAutoStart [getset]
 If true, indicates that this entry point should be offered as an auto-start candidate to the user.
 
bool SuggestSendTo [getset]
 If true, indicates that this entry point should be offered as a candidate for the "Send To" context menu to the user.
 
string?? NeedsTerminalString [getset]
 Used for XML serialization. More...
 
string?? SuggestAutoStartString [getset]
 Used for XML serialization. More...
 
string?? SuggestSendToString [getset]
 Used for XML serialization. More...
 
LocalizableStringCollection Names = new() [get]
 User-friendly names for the command. If not present, Command is used instead.
 
LocalizableStringCollection Summaries = new() [get]
 
LocalizableStringCollection Descriptions = new() [get]
 
List< IconIcons = new() [get]
 Zero or more icons representing the command. Used for desktop icons, menu entries, etc..
 
- 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...
 
- Properties inherited from ZeroInstall.Model.IIconContainer
List< IconIcons [get]
 Zero or more icons.
 
- Properties inherited from ZeroInstall.Model.ISummaryContainer
LocalizableStringCollection Summaries [get]
 Short one-line descriptions for different languages; the first word should not be upper-case unless it is a proper noun (e.g. "cures all ills").
 
- Properties inherited from ZeroInstall.Model.IDescriptionContainer
LocalizableStringCollection Descriptions [get]
 Full descriptions for different languages, which can be several paragraphs long.
 

Additional Inherited Members

- 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

Associates a Command with a user-friendly name and description.

See also
Feed.EntryPoints

Member Function Documentation

◆ Clone()

EntryPoint ZeroInstall.Model.EntryPoint.Clone ( )
inline

Creates a deep copy of this EntryPoint instance.

Returns
The new copy of the EntryPoint.

◆ Normalize()

void ZeroInstall.Model.EntryPoint.Normalize ( )

Converts legacy elements, sets default values, etc..

Exceptions
InvalidDataExceptionA required property is not set or invalid.

Property Documentation

◆ BinaryName

string? ZeroInstall.Model.EntryPoint.BinaryName
getset

The canonical name of the binary supplying the command (without file extensions). This is used to suggest suitable alias names.

Will default to Command when left null.

◆ NeedsTerminalString

string?? ZeroInstall.Model.EntryPoint.NeedsTerminalString
getset

Used for XML serialization.

See also
NeedsTerminal

◆ SuggestAutoStartString

string?? ZeroInstall.Model.EntryPoint.SuggestAutoStartString
getset

Used for XML serialization.

See also
SuggestAutoStart

◆ SuggestSendToString

string?? ZeroInstall.Model.EntryPoint.SuggestSendToString
getset

Used for XML serialization.

See also
SuggestSendTo

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