Zero Install .NET API 2.20.0
ZeroInstall.DesktopIntegration.AccessPoints.CommandAccessPoint Class Reference

Adds a way to explicitly launch the application to the desktop environment. More...

Inheritance diagram for ZeroInstall.DesktopIntegration.AccessPoints.CommandAccessPoint:
ZeroInstall.DesktopIntegration.AccessPoints.AccessPoint ZeroInstall.Model.XmlUnknown NanoByte.Common.ICloneable< AccessPoint > ZeroInstall.DesktopIntegration.AccessPoints.AppAlias ZeroInstall.DesktopIntegration.AccessPoints.AutoStart ZeroInstall.DesktopIntegration.AccessPoints.IconAccessPoint ZeroInstall.DesktopIntegration.AccessPoints.DesktopIcon ZeroInstall.DesktopIntegration.AccessPoints.MenuEntry ZeroInstall.DesktopIntegration.AccessPoints.QuickLaunch ZeroInstall.DesktopIntegration.AccessPoints.SendTo

Public Member Functions

override string ToString ()
 Returns the access point in the form "AccessPointType: Name (Command)". Not safe for parsing!
 
override int GetHashCode ()
 
- Public Member Functions inherited from ZeroInstall.DesktopIntegration.AccessPoints.AccessPoint
abstract IEnumerable< string > GetConflictIDs (AppEntry appEntry)
 Retrieves identifiers from a namespace global to all AccessPoints. Collisions in this namespace indicate that the respective AccessPoints are in conflict cannot be applied on a system at the same time. More...
 
abstract void Apply (AppEntry appEntry, Feed feed, IIconStore iconStore, bool machineWide)
 Applies this access point to the current machine. More...
 
abstract void Unapply (AppEntry appEntry, bool machineWide)
 Unapply this access point on the current machine. More...
 
abstract AccessPoint Clone ()
 Creates a deep copy of this AccessPoint instance. More...
 
- 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< AccessPoint >
AccessPoint Clone ()
 

Protected Member Functions

void ValidateName ()
 Ensures that the given name can be used as a file name. More...
 
bool Equals (CommandAccessPoint? 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)
 

Properties

string? Name [getset]
 The name of the menu entry, icon, command-line, etc..
 
string? Command [getset]
 The name of the Model.Command to use when launching via this access point. Leave empty to use default.
 

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.
 

Detailed Description

Adds a way to explicitly launch the application to the desktop environment.

See also
Model.Command

Member Function Documentation

◆ ValidateName()

void ZeroInstall.DesktopIntegration.AccessPoints.CommandAccessPoint.ValidateName ( )
inlineprotected

Ensures that the given name can be used as a file name.

Exceptions
IOExceptionName contains invalid characters.

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