Class EntryPoint

Namespace

ZeroInstall.Model

Assembly

ZeroInstall.Model.dll

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

[Serializable]
[Equatable]
public sealed class EntryPoint : FeedElement, IEquatable<XmlUnknown>, IEquatable<FeedElement>, IIconContainer, ISummaryContainer, IDescriptionContainer, ICloneable<EntryPoint>, IEquatable<EntryPoint>

Inheritance

object

XmlUnknown

FeedElement

EntryPoint

Implements

IEquatable<XmlUnknown>

IEquatable<FeedElement>

IIconContainer

ISummaryContainer

IDescriptionContainer

ICloneable<EntryPoint>

IEquatable<EntryPoint>

Inherited Members

FeedElement.IfZeroInstallVersion

XmlUnknown.UnknownAttributes

XmlUnknown.UnknownElements

XmlUnknown.ToShortXml()

XmlUnknown.Equals(XmlUnknown)

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

AppId

The Application User Model ID; used by Windows to associate shortcuts and pinned taskbar entries with running processes. May not be longer than 128 characters and may not contain whitespace.

public string? AppId { get; set; }

Property Value

string

BinaryName

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

public string? BinaryName { get; set; }

Property Value

string

Remarks

Will default to Command when left null.

Command

The name of the Command this entry point represents.

[TypeConverter(typeof(CommandNameConverter))]
public required string Command { get; set; }

Property Value

string

Descriptions

Full descriptions for different languages, which can be several paragraphs long.

[Browsable(false)]
[OrderedEquality]
public LocalizableStringCollection Descriptions { get; }

Property Value

LocalizableStringCollection

Icons

Zero or more icons representing the command. Used for desktop icons, menu entries, etc..

[Browsable(false)]
[OrderedEquality]
public List<Icon> Icons { get; }

Property Value

List<Icon>

Names

User-friendly names for the command. If not present, Command is used instead.

[Browsable(false)]
[OrderedEquality]
public LocalizableStringCollection Names { get; }

Property Value

LocalizableStringCollection

NeedsTerminal

If true, indicates that the Command represented by this entry point requires a terminal in order to run.

public bool NeedsTerminal { get; set; }

Property Value

bool

SuggestAutoStart

If true, indicates that this entry point should be offered as an auto-start candidate to the user.

public bool SuggestAutoStart { get; set; }

Property Value

bool

SuggestSendTo

If true, indicates that this entry point should be offered as a candidate for the "Send To" context menu to the user.

public bool SuggestSendTo { get; set; }

Property Value

bool

Summaries

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").

[Browsable(false)]
[OrderedEquality]
public LocalizableStringCollection Summaries { get; }

Property Value

LocalizableStringCollection

Methods

Clone()

Creates a deep copy of this EntryPoint instance.

public EntryPoint Clone()

Returns

EntryPoint

The new copy of the EntryPoint.

Equals(object?)

Determines whether the specified object is equal to the current object.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current object.

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

Normalize()

Converts legacy elements, sets default values, etc..

public void Normalize()

Exceptions

InvalidDataException

A required property is not set or invalid.

ToString()

Returns the EntryPoint in the form "Command (BinaryName)". Not safe for parsing!

public override string ToString()

Returns

string

Operators

operator ==(EntryPoint?, EntryPoint?)

Indicates whether the object on the left is equal to the object on the right.

public static bool operator ==(EntryPoint? left, EntryPoint? right)

Parameters

left EntryPoint

The left object

right EntryPoint

The right object

Returns

bool

true if the objects are equal; otherwise, false.

operator !=(EntryPoint?, EntryPoint?)

Indicates whether the object on the left is not equal to the object on the right.

public static bool operator !=(EntryPoint? left, EntryPoint? right)

Parameters

left EntryPoint

The left object

right EntryPoint

The right object

Returns

bool

true if the objects are not equal; otherwise, false.

See Also

EntryPoints