Files
Umbraco-CMS/src/Umbraco.Core/Models/IFile.cs
2016-04-15 13:25:11 +02:00

50 lines
1.5 KiB
C#

using System;
using Umbraco.Core.Models.EntityBase;
namespace Umbraco.Core.Models
{
/// <summary>
/// Defines a File
/// </summary>
/// <remarks>Used for Scripts, Stylesheets and Templates</remarks>
public interface IFile : IAggregateRoot
{
/// <summary>
/// Gets the Name of the File including extension
/// </summary>
string Name { get; }
/// <summary>
/// Gets the Alias of the File, which is the name without the extension
/// </summary>
string Alias { get; }
/// <summary>
/// Gets or sets the Path to the File from the root of the file's associated IFileSystem
/// </summary>
string Path { get; set; }
/// <summary>
/// Gets the original path of the file
/// </summary>
string OriginalPath { get; }
/// <summary>
/// Called to re-set the OriginalPath to the Path
/// </summary>
void ResetOriginalPath();
/// <summary>
/// Gets or sets the Content of a File
/// </summary>
string Content { get; set; }
/// <summary>
/// Gets or sets the file's virtual path (i.e. the file path relative to the root of the website)
/// </summary>
string VirtualPath { get; set; }
[Obsolete("This is no longer used and will be removed from the codebase in future versions")]
bool IsValid();
}
}