Interface IExternalLinksSelectionEdit
Inherited Members
Namespace: Estrelica.Archer.Content
Assembly: Estrelica.Interfaces.dll
Syntax
[StayPublic]
[DoNotObfuscateType]
public interface IExternalLinksSelectionEdit : IEditableFieldSelection<IExternalLinkEdit>, IEditableEnumerable<IExternalLinkEdit>, IEnumerable<IExternalLinkEdit>, IEnumerable, IEditableField, IEditable, IClearableMethods
Add(string, string, int)
Adds a new External link
Declaration
bool Add(string url, string name = null, int sortOrder = 0)Parameters
|
string
url
The url for the new link. Must be a properly-formatted URL, and must be unique within the collection or Archer will reject it. |
|
string
name
An optional Name which will be used as the display text for the URL. If null, the URL itself will be displayed |
|
int
sortOrder
An optional 1-based index where the link should be placed within the collection. If <=0 or > the size of the collection, the link will be added to the end. |
Returns
|
bool
True if the link was added, otherwise False |
Remarks
Although Archer supports SortOrder in its data model, this value appears to be ignored when ordering links for display. As of version 6.12 all links are rendered in the UI in alphabetical order by Name. Furthermore, since there is no provision for re-ordering links within the UI, it appears that this is an orphaned property. Regardless, Estrelica.Core supports it just in case Archer starts observing it in a future release.
Remove(string, string)
Removes an External Link having the given url and display name
Declaration
bool Remove(string url, string name)Parameters
| string url |
| string name |
Returns
|
bool
True if the link was found and removed, otherwise False |