Class FavIcon
Manages the FavIcon of a portal.
Inheritance
System.Object
FavIcon
Namespace: DotNetNuke.UI.Internals
Assembly: DotNetNuke.dll
Syntax
public class FavIcon : objectConstructors
| Improve this Doc View SourceFavIcon(Int32)
Initializes a new instance of the FavIcon class. Initializes a FavIcon instance.
Declaration
public FavIcon(int portalId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | portalId | The id of the portal. |
Methods
| Improve this Doc View SourceGetHeaderLink(Int32)
Get the HTML for a favicon link.
Declaration
public static string GetHeaderLink(int portalId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | portalId | The portal id. |
Returns
| Type | Description |
|---|---|
| System.String | The HTML for the favicon link for the portal, or an empty string if there is no favicon. |
GetSettingPath()
Get the path of the favicon file relative to the portal root.
Declaration
public string GetSettingPath()Returns
| Type | Description |
|---|---|
| System.String | Path to the favicon file relative to portal root, or empty string when there is no favicon set. |
Remarks
This relative path is only relevant to use with Host/Portal Settings the path is not guaranteed any physical relevance in the local file system.
Update(Int32)
Update the file to use for a favIcon.
Declaration
public void Update(int fileId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | fileId | The file id or Null.NullInteger for none. |