Class EntryPoint
Associates a Command with a user-friendly name and description.
Implements
Inherited Members
Namespace: ZeroInstall.Model
Assembly: ZeroInstall.Model.dll
Syntax
public sealed class EntryPoint : FeedElement, IIconContainer, ISummaryContainer, IDescriptionContainer
Constructors
EntryPoint()
Declaration
public EntryPoint()
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.
Declaration
public string AppId { get; set; }
Property Value
Type | Description |
---|---|
String |
BinaryName
The canonical name of the binary supplying the command (without file extensions). This is used to suggest suitable alias names.
Declaration
public string BinaryName { get; set; }
Property Value
Type | Description |
---|---|
String |
Remarks
Will default to Command when left null
.
Command
The name of the Command this entry point represents.
Declaration
public string Command { get; set; }
Property Value
Type | Description |
---|---|
String |
Descriptions
Full descriptions for different languages, which can be several paragraphs long.
Declaration
public LocalizableStringCollection Descriptions { get; }
Property Value
Type | Description |
---|---|
LocalizableStringCollection |
Icons
Zero or more icons representing the command. Used for desktop icons, menu entries, etc..
Declaration
public List<Icon> Icons { get; }
Property Value
Type | Description |
---|---|
List<Icon> |
Names
User-friendly names for the command. If not present, Command is used instead.
Declaration
public LocalizableStringCollection Names { get; }
Property Value
Type | Description |
---|---|
LocalizableStringCollection |
NeedsTerminal
If true
, indicates that the Command represented by this entry point requires a terminal in order to run.
Declaration
public bool NeedsTerminal { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
NeedsTerminalString
Used for XML serialization.
Declaration
public string NeedsTerminalString { get; set; }
Property Value
Type | Description |
---|---|
String |
See Also
SuggestAutoStart
If true
, indicates that this entry point should be offered as an auto-start candidate to the user.
Declaration
public bool SuggestAutoStart { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
SuggestAutoStartString
Used for XML serialization.
Declaration
public string SuggestAutoStartString { get; set; }
Property Value
Type | Description |
---|---|
String |
See Also
SuggestSendTo
If true
, indicates that this entry point should be offered as a candidate for the "Send To" context menu to the user.
Declaration
public bool SuggestSendTo { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
SuggestSendToString
Used for XML serialization.
Declaration
public string SuggestSendToString { get; set; }
Property Value
Type | Description |
---|---|
String |
See Also
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").
Declaration
public LocalizableStringCollection Summaries { get; }
Property Value
Type | Description |
---|---|
LocalizableStringCollection |
Methods
Clone()
Creates a deep copy of this EntryPoint instance.
Declaration
public EntryPoint Clone()
Returns
Type | Description |
---|---|
EntryPoint | The new copy of the EntryPoint. |
Equals(Object)
Declaration
public override bool Equals(object obj)
Parameters
Type | Name | Description |
---|---|---|
Object | obj |
Returns
Type | Description |
---|---|
Boolean |
Overrides
Equals(EntryPoint)
Declaration
public bool Equals(EntryPoint other)
Parameters
Type | Name | Description |
---|---|---|
EntryPoint | other |
Returns
Type | Description |
---|---|
Boolean |
GetHashCode()
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
Int32 |
Overrides
Normalize()
Converts legacy elements, sets default values, etc..
Declaration
public void Normalize()
Exceptions
Type | Condition |
---|---|
InvalidDataException | A required property is not set or invalid. |
ToString()
Returns the EntryPoint in the form "Command (BinaryName)". Not safe for parsing!
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
String |
Operators
Equality(EntryPoint, EntryPoint)
Indicates whether the object on the left is equal to the object on the right.
Declaration
public static bool operator ==(EntryPoint left, EntryPoint right)
Parameters
Type | Name | Description |
---|---|---|
EntryPoint | left | The left object |
EntryPoint | right | The right object |
Returns
Type | Description |
---|---|
Boolean | true if the objects are equal; otherwise, false. |
Inequality(EntryPoint, EntryPoint)
Indicates whether the object on the left is not equal to the object on the right.
Declaration
public static bool operator !=(EntryPoint left, EntryPoint right)
Parameters
Type | Name | Description |
---|---|---|
EntryPoint | left | The left object |
EntryPoint | right | The right object |
Returns
Type | Description |
---|---|
Boolean | true if the objects are not equal; otherwise, false. |