Class FileService
Represents the File Service, which is an easy access to operations involving IFile objects like Scripts, Stylesheets and Templates
Inheritance
System.Object
Namespace:System.Dynamic.ExpandoObject
Assembly:Umbraco.Core.dll
Syntax
public class FileService : ScopeRepositoryService, IFileService, IService
Constructors
FileService(IDatabaseUnitOfWorkProvider, RepositoryFactory, ILogger, IEventMessagesFactory)
Declaration
public FileService(IDatabaseUnitOfWorkProvider provider, RepositoryFactory repositoryFactory, ILogger logger, IEventMessagesFactory eventMessagesFactory)
Parameters
Methods
CreatePartialView(IPartialView, String, Int32)
Declaration
public Attempt<IPartialView> CreatePartialView(IPartialView partialView, string snippetName = null, int userId = 0)
Parameters
Type |
Name |
Description |
IPartialView |
partialView |
|
System.String |
snippetName |
|
System.Int32 |
userId |
|
Returns
CreatePartialViewFolder(String)
Declaration
public void CreatePartialViewFolder(string folderPath)
Parameters
Type |
Name |
Description |
System.String |
folderPath |
|
CreatePartialViewMacro(IPartialView, String, Int32)
Declaration
public Attempt<IPartialView> CreatePartialViewMacro(IPartialView partialView, string snippetName = null, int userId = 0)
Parameters
Type |
Name |
Description |
IPartialView |
partialView |
|
System.String |
snippetName |
|
System.Int32 |
userId |
|
Returns
CreatePartialViewMacroFolder(String)
Declaration
public void CreatePartialViewMacroFolder(string folderPath)
Parameters
Type |
Name |
Description |
System.String |
folderPath |
|
CreateScriptFolder(String)
Declaration
public void CreateScriptFolder(string folderPath)
Parameters
Type |
Name |
Description |
System.String |
folderPath |
|
CreateTemplateForContentType(String, String, Int32)
Creates a template for a content type
Declaration
public Attempt<OperationStatus<ITemplate, OperationStatusType>> CreateTemplateForContentType(string contentTypeAlias, string contentTypeName, int userId = 0)
Parameters
Type |
Name |
Description |
System.String |
contentTypeAlias |
|
System.String |
contentTypeName |
|
System.Int32 |
userId |
|
Returns
CreateTemplateWithIdentity(String, String, ITemplate, Int32)
Declaration
public ITemplate CreateTemplateWithIdentity(string name, string content, ITemplate masterTemplate = null, int userId = 0)
Parameters
Type |
Name |
Description |
System.String |
name |
|
System.String |
content |
|
ITemplate |
masterTemplate |
|
System.Int32 |
userId |
|
Returns
DeletePartialView(String, Int32)
Declaration
public bool DeletePartialView(string path, int userId = 0)
Parameters
Type |
Name |
Description |
System.String |
path |
|
System.Int32 |
userId |
|
Returns
Type |
Description |
System.Boolean |
|
DeletePartialViewFolder(String)
Declaration
public void DeletePartialViewFolder(string folderPath)
Parameters
Type |
Name |
Description |
System.String |
folderPath |
|
DeletePartialViewMacro(String, Int32)
Declaration
public bool DeletePartialViewMacro(string path, int userId = 0)
Parameters
Type |
Name |
Description |
System.String |
path |
|
System.Int32 |
userId |
|
Returns
Type |
Description |
System.Boolean |
|
DeletePartialViewMacroFolder(String)
Declaration
public void DeletePartialViewMacroFolder(string folderPath)
Parameters
Type |
Name |
Description |
System.String |
folderPath |
|
DeleteScript(String, Int32)
Deletes a script by its name
Declaration
public void DeleteScript(string path, int userId = 0)
Parameters
Type |
Name |
Description |
System.String |
path |
Name incl. extension of the Script to delete
|
System.Int32 |
userId |
|
DeleteScriptFolder(String)
Declaration
public void DeleteScriptFolder(string folderPath)
Parameters
Type |
Name |
Description |
System.String |
folderPath |
|
DeleteStylesheet(String, Int32)
Deletes a stylesheet by its name
Declaration
public void DeleteStylesheet(string path, int userId = 0)
Parameters
Type |
Name |
Description |
System.String |
path |
Name incl. extension of the Stylesheet to delete
|
System.Int32 |
userId |
|
DeleteTemplate(String, Int32)
Deletes a template by its alias
Declaration
public void DeleteTemplate(string alias, int userId = 0)
Parameters
Type |
Name |
Description |
System.String |
alias |
Alias of the ITemplate to delete
|
System.Int32 |
userId |
|
DetermineTemplateRenderingEngine(ITemplate)
This checks what the default rendering engine is set in config but then also ensures that there isn't already
a template that exists in the opposite rendering engine's template folder, then returns the appropriate
rendering engine to use.
Declaration
public RenderingEngine DetermineTemplateRenderingEngine(ITemplate template)
Parameters
Returns
FindTemplateInTree(TemplateNode, String)
Given a template node in a tree, this will find the template node with the given alias if it is found in the hierarchy, otherwise null
Declaration
[Obsolete("Use GetDescendants instead")]
public TemplateNode FindTemplateInTree(TemplateNode anyNode, string alias)
Parameters
Type |
Name |
Description |
TemplateNode |
anyNode |
|
System.String |
alias |
|
Returns
GetMacroScript(String)
Declaration
[Obsolete("MacroScripts are obsolete - this is for backwards compatibility with upgraded sites.")]
public IPartialView GetMacroScript(string path)
Parameters
Type |
Name |
Description |
System.String |
path |
|
Returns
GetMacroScriptFileContentStream(String)
Declaration
public Stream GetMacroScriptFileContentStream(string filepath)
Parameters
Type |
Name |
Description |
System.String |
filepath |
|
Returns
Type |
Description |
System.IO.Stream |
|
GetMacroScriptFileSize(String)
Declaration
public long GetMacroScriptFileSize(string filepath)
Parameters
Type |
Name |
Description |
System.String |
filepath |
|
Returns
Type |
Description |
System.Int64 |
|
GetPartialView(String)
Declaration
public IPartialView GetPartialView(string path)
Parameters
Type |
Name |
Description |
System.String |
path |
|
Returns
GetPartialViewFileContentStream(String)
Declaration
public Stream GetPartialViewFileContentStream(string filepath)
Parameters
Type |
Name |
Description |
System.String |
filepath |
|
Returns
Type |
Description |
System.IO.Stream |
|
GetPartialViewFileSize(String)
Declaration
public long GetPartialViewFileSize(string filepath)
Parameters
Type |
Name |
Description |
System.String |
filepath |
|
Returns
Type |
Description |
System.Int64 |
|
GetPartialViewMacro(String)
Declaration
public IPartialView GetPartialViewMacro(string path)
Parameters
Type |
Name |
Description |
System.String |
path |
|
Returns
GetPartialViewMacroFileContentStream(String)
Declaration
public Stream GetPartialViewMacroFileContentStream(string filepath)
Parameters
Type |
Name |
Description |
System.String |
filepath |
|
Returns
Type |
Description |
System.IO.Stream |
|
GetPartialViewMacroFileSize(String)
Declaration
public long GetPartialViewMacroFileSize(string filepath)
Parameters
Type |
Name |
Description |
System.String |
filepath |
|
Returns
Type |
Description |
System.Int64 |
|
GetPartialViewMacros(String[])
Declaration
public IEnumerable<IPartialView> GetPartialViewMacros(params string[] names)
Parameters
Type |
Name |
Description |
System.String[] |
names |
|
Returns
Type |
Description |
System.Collections.Generic.IEnumerable<IPartialView> |
|
GetPartialViewMacroSnippetContent(String)
Declaration
public string GetPartialViewMacroSnippetContent(string snippetName)
Parameters
Type |
Name |
Description |
System.String |
snippetName |
|
Returns
Type |
Description |
System.String |
|
GetPartialViewSnippetContent(String)
Declaration
public string GetPartialViewSnippetContent(string snippetName)
Parameters
Type |
Name |
Description |
System.String |
snippetName |
|
Returns
Type |
Description |
System.String |
|
GetPartialViewSnippetNames(String[])
Declaration
public IEnumerable<string> GetPartialViewSnippetNames(params string[] filterNames)
Parameters
Type |
Name |
Description |
System.String[] |
filterNames |
|
Returns
Type |
Description |
System.Collections.Generic.IEnumerable<System.String> |
|
GetScriptByName(String)
Gets a Script object by its name
Declaration
public Script GetScriptByName(string name)
Parameters
Type |
Name |
Description |
System.String |
name |
Name of the script incl. extension
|
Returns
GetScriptFileContentStream(String)
Declaration
public Stream GetScriptFileContentStream(string filepath)
Parameters
Type |
Name |
Description |
System.String |
filepath |
|
Returns
Type |
Description |
System.IO.Stream |
|
GetScriptFileSize(String)
Declaration
public long GetScriptFileSize(string filepath)
Parameters
Type |
Name |
Description |
System.String |
filepath |
|
Returns
Type |
Description |
System.Int64 |
|
GetScripts(String[])
Gets a list of all Script objects
Declaration
public IEnumerable<Script> GetScripts(params string[] names)
Parameters
Type |
Name |
Description |
System.String[] |
names |
|
Returns
Type |
Description |
System.Collections.Generic.IEnumerable<Script> |
An enumerable list of Script objects
|
GetStylesheetByName(String)
Declaration
public Stylesheet GetStylesheetByName(string name)
Parameters
Type |
Name |
Description |
System.String |
name |
Name of the stylesheet incl. extension
|
Returns
GetStylesheetFileContentStream(String)
Declaration
public Stream GetStylesheetFileContentStream(string filepath)
Parameters
Type |
Name |
Description |
System.String |
filepath |
|
Returns
Type |
Description |
System.IO.Stream |
|
GetStylesheetFileSize(String)
Declaration
public long GetStylesheetFileSize(string filepath)
Parameters
Type |
Name |
Description |
System.String |
filepath |
|
Returns
Type |
Description |
System.Int64 |
|
GetStylesheets(String[])
Declaration
public IEnumerable<Stylesheet> GetStylesheets(params string[] names)
Parameters
Type |
Name |
Description |
System.String[] |
names |
|
Returns
Type |
Description |
System.Collections.Generic.IEnumerable<Stylesheet> |
An enumerable list of Stylesheet objects
|
GetTemplate(Guid)
Gets a ITemplate object by its guid identifier.
Declaration
public ITemplate GetTemplate(Guid id)
Parameters
Type |
Name |
Description |
System.Guid |
id |
The guid identifier of the template.
|
Returns
GetTemplate(Int32)
Declaration
public ITemplate GetTemplate(int id)
Parameters
Type |
Name |
Description |
System.Int32 |
id |
The identifer of the template.
|
Returns
GetTemplate(String)
Declaration
public ITemplate GetTemplate(string alias)
Parameters
Type |
Name |
Description |
System.String |
alias |
The alias of the template.
|
Returns
GetTemplateChildren(Int32)
Gets the template children
Declaration
public IEnumerable<ITemplate> GetTemplateChildren(int masterTemplateId)
Parameters
Type |
Name |
Description |
System.Int32 |
masterTemplateId |
|
Returns
Type |
Description |
System.Collections.Generic.IEnumerable<ITemplate> |
|
GetTemplateChildren(String)
Gets the template children
Declaration
public IEnumerable<ITemplate> GetTemplateChildren(string alias)
Parameters
Type |
Name |
Description |
System.String |
alias |
|
Returns
Type |
Description |
System.Collections.Generic.IEnumerable<ITemplate> |
|
GetTemplateDescendants(Int32)
Gets the template descendants
Declaration
public IEnumerable<ITemplate> GetTemplateDescendants(int masterTemplateId)
Parameters
Type |
Name |
Description |
System.Int32 |
masterTemplateId |
|
Returns
Type |
Description |
System.Collections.Generic.IEnumerable<ITemplate> |
|
GetTemplateDescendants(String)
Declaration
public IEnumerable<ITemplate> GetTemplateDescendants(string alias)
Parameters
Type |
Name |
Description |
System.String |
alias |
|
Returns
Type |
Description |
System.Collections.Generic.IEnumerable<ITemplate> |
|
GetTemplateFileContentStream(String)
Declaration
public Stream GetTemplateFileContentStream(string filepath)
Parameters
Type |
Name |
Description |
System.String |
filepath |
|
Returns
Type |
Description |
System.IO.Stream |
|
GetTemplateFileSize(String)
Declaration
public long GetTemplateFileSize(string filepath)
Parameters
Type |
Name |
Description |
System.String |
filepath |
|
Returns
Type |
Description |
System.Int64 |
|
GetTemplateNode(String)
Returns a template as a template node which can be traversed (parent, children)
Declaration
[Obsolete("Use GetDescendants instead")]
public TemplateNode GetTemplateNode(string alias)
Parameters
Type |
Name |
Description |
System.String |
alias |
|
Returns
GetTemplates(Int32)
Declaration
public IEnumerable<ITemplate> GetTemplates(int masterTemplateId)
Parameters
Type |
Name |
Description |
System.Int32 |
masterTemplateId |
|
Returns
Type |
Description |
System.Collections.Generic.IEnumerable<ITemplate> |
An enumerable list of ITemplate objects
|
GetTemplates(String[])
Declaration
public IEnumerable<ITemplate> GetTemplates(params string[] aliases)
Parameters
Type |
Name |
Description |
System.String[] |
aliases |
|
Returns
Type |
Description |
System.Collections.Generic.IEnumerable<ITemplate> |
An enumerable list of ITemplate objects
|
GetUserControl(String)
Declaration
[Obsolete("UserControls are obsolete - this is for backwards compatibility with upgraded sites.")]
public IUserControl GetUserControl(string path)
Parameters
Type |
Name |
Description |
System.String |
path |
|
Returns
GetUserControlFileContentStream(String)
Declaration
public Stream GetUserControlFileContentStream(string filepath)
Parameters
Type |
Name |
Description |
System.String |
filepath |
|
Returns
Type |
Description |
System.IO.Stream |
|
GetUserControlFileSize(String)
Declaration
public long GetUserControlFileSize(string filepath)
Parameters
Type |
Name |
Description |
System.String |
filepath |
|
Returns
Type |
Description |
System.Int64 |
|
GetXsltFile(String)
Declaration
public IXsltFile GetXsltFile(string path)
Parameters
Type |
Name |
Description |
System.String |
path |
|
Returns
GetXsltFileContentStream(String)
Declaration
public Stream GetXsltFileContentStream(string filepath)
Parameters
Type |
Name |
Description |
System.String |
filepath |
|
Returns
Type |
Description |
System.IO.Stream |
|
GetXsltFiles(String[])
Declaration
public IEnumerable<IXsltFile> GetXsltFiles(params string[] names)
Parameters
Type |
Name |
Description |
System.String[] |
names |
|
Returns
Type |
Description |
System.Collections.Generic.IEnumerable<IXsltFile> |
|
GetXsltFileSize(String)
Declaration
public long GetXsltFileSize(string filepath)
Parameters
Type |
Name |
Description |
System.String |
filepath |
|
Returns
Type |
Description |
System.Int64 |
|
SavePartialView(IPartialView, Int32)
Declaration
public Attempt<IPartialView> SavePartialView(IPartialView partialView, int userId = 0)
Parameters
Type |
Name |
Description |
IPartialView |
partialView |
|
System.Int32 |
userId |
|
Returns
SavePartialViewMacro(IPartialView, Int32)
Declaration
public Attempt<IPartialView> SavePartialViewMacro(IPartialView partialView, int userId = 0)
Parameters
Type |
Name |
Description |
IPartialView |
partialView |
|
System.Int32 |
userId |
|
Returns
SaveScript(Script, Int32)
Declaration
public void SaveScript(Script script, int userId = 0)
Parameters
Type |
Name |
Description |
Script |
script |
Script to save
|
System.Int32 |
userId |
|
SaveStylesheet(Stylesheet, Int32)
Declaration
public void SaveStylesheet(Stylesheet stylesheet, int userId = 0)
Parameters
SaveTemplate(IEnumerable<ITemplate>, Int32)
Declaration
public void SaveTemplate(IEnumerable<ITemplate> templates, int userId = 0)
Parameters
Type |
Name |
Description |
System.Collections.Generic.IEnumerable<ITemplate> |
templates |
List of Template to save
|
System.Int32 |
userId |
Optional id of the user
|
SaveTemplate(ITemplate, Int32)
Declaration
public void SaveTemplate(ITemplate template, int userId = 0)
Parameters
SetMacroScriptFileContent(String, Stream)
Declaration
public void SetMacroScriptFileContent(string filepath, Stream content)
Parameters
Type |
Name |
Description |
System.String |
filepath |
|
System.IO.Stream |
content |
|
SetPartialViewFileContent(String, Stream)
Declaration
public void SetPartialViewFileContent(string filepath, Stream content)
Parameters
Type |
Name |
Description |
System.String |
filepath |
|
System.IO.Stream |
content |
|
SetPartialViewMacroFileContent(String, Stream)
Declaration
public void SetPartialViewMacroFileContent(string filepath, Stream content)
Parameters
Type |
Name |
Description |
System.String |
filepath |
|
System.IO.Stream |
content |
|
SetScriptFileContent(String, Stream)
Declaration
public void SetScriptFileContent(string filepath, Stream content)
Parameters
Type |
Name |
Description |
System.String |
filepath |
|
System.IO.Stream |
content |
|
SetStylesheetFileContent(String, Stream)
Declaration
public void SetStylesheetFileContent(string filepath, Stream content)
Parameters
Type |
Name |
Description |
System.String |
filepath |
|
System.IO.Stream |
content |
|
SetTemplateFileContent(String, Stream)
Declaration
public void SetTemplateFileContent(string filepath, Stream content)
Parameters
Type |
Name |
Description |
System.String |
filepath |
|
System.IO.Stream |
content |
|
SetUserControlFileContent(String, Stream)
Declaration
public void SetUserControlFileContent(string filepath, Stream content)
Parameters
Type |
Name |
Description |
System.String |
filepath |
|
System.IO.Stream |
content |
|
SetXsltFileContent(String, Stream)
Declaration
public void SetXsltFileContent(string filepath, Stream content)
Parameters
Type |
Name |
Description |
System.String |
filepath |
|
System.IO.Stream |
content |
|
ValidatePartialView(PartialView)
Declaration
public bool ValidatePartialView(PartialView partialView)
Parameters
Returns
Type |
Description |
System.Boolean |
|
ValidatePartialViewMacro(PartialView)
Declaration
public bool ValidatePartialViewMacro(PartialView partialView)
Parameters
Returns
Type |
Description |
System.Boolean |
|
ValidateScript(Script)
Declaration
public bool ValidateScript(Script script)
Parameters
Returns
Type |
Description |
System.Boolean |
True if Script is valid, otherwise false
|
ValidateStylesheet(Stylesheet)
Declaration
public bool ValidateStylesheet(Stylesheet stylesheet)
Parameters
Returns
Type |
Description |
System.Boolean |
True if Stylesheet is valid, otherwise false
|
ValidateTemplate(ITemplate)
Declaration
public bool ValidateTemplate(ITemplate template)
Parameters
Returns
Type |
Description |
System.Boolean |
True if Script is valid, otherwise false
|
Events
CreatedPartialView
Declaration
public static event TypedEventHandler<IFileService, NewEventArgs<IPartialView>> CreatedPartialView
Event Type
CreatingPartialView
Declaration
public static event TypedEventHandler<IFileService, NewEventArgs<IPartialView>> CreatingPartialView
Event Type
DeletedPartialView
Declaration
public static event TypedEventHandler<IFileService, DeleteEventArgs<IPartialView>> DeletedPartialView
Event Type
DeletedScript
Declaration
public static event TypedEventHandler<IFileService, DeleteEventArgs<Script>> DeletedScript
Event Type
DeletedStylesheet
Declaration
public static event TypedEventHandler<IFileService, DeleteEventArgs<Stylesheet>> DeletedStylesheet
Event Type
DeletedTemplate
Declaration
public static event TypedEventHandler<IFileService, DeleteEventArgs<ITemplate>> DeletedTemplate
Event Type
DeletingPartialView
Declaration
public static event TypedEventHandler<IFileService, DeleteEventArgs<IPartialView>> DeletingPartialView
Event Type
DeletingScript
Declaration
public static event TypedEventHandler<IFileService, DeleteEventArgs<Script>> DeletingScript
Event Type
DeletingStylesheet
Declaration
public static event TypedEventHandler<IFileService, DeleteEventArgs<Stylesheet>> DeletingStylesheet
Event Type
DeletingTemplate
Declaration
public static event TypedEventHandler<IFileService, DeleteEventArgs<ITemplate>> DeletingTemplate
Event Type
SavedPartialView
Declaration
public static event TypedEventHandler<IFileService, SaveEventArgs<IPartialView>> SavedPartialView
Event Type
SavedScript
Declaration
public static event TypedEventHandler<IFileService, SaveEventArgs<Script>> SavedScript
Event Type
SavedStylesheet
Declaration
public static event TypedEventHandler<IFileService, SaveEventArgs<Stylesheet>> SavedStylesheet
Event Type
SavedTemplate
Declaration
public static event TypedEventHandler<IFileService, SaveEventArgs<ITemplate>> SavedTemplate
Event Type
SavingPartialView
Declaration
public static event TypedEventHandler<IFileService, SaveEventArgs<IPartialView>> SavingPartialView
Event Type
SavingScript
Declaration
public static event TypedEventHandler<IFileService, SaveEventArgs<Script>> SavingScript
Event Type
SavingStylesheet
Declaration
public static event TypedEventHandler<IFileService, SaveEventArgs<Stylesheet>> SavingStylesheet
Event Type
SavingTemplate
Declaration
public static event TypedEventHandler<IFileService, SaveEventArgs<ITemplate>> SavingTemplate
Event Type