View Source

Interface IFileService

Defines the File Service, which is an easy access to operations involving IFile objects like Scripts, Stylesheets and Templates

Namespace: Umbraco.Core.Services

Assembly: Umbraco.Core.dll

Syntax

public interface IFileService : IService

Methods

View Source

CreatePartialView(IPartialView, String, Int32)

Declaration

Attempt<IPartialView> CreatePartialView(IPartialView partialView, string snippetName = null, int userId = -1)

Parameters

Type	Name	Description
IPartialView	partialView
System.String	snippetName
System.Int32	userId

Returns

Type	Description
Attempt<IPartialView>

View Source

CreatePartialViewFolder(String)

Declaration

void CreatePartialViewFolder(string folderPath)

Parameters

Type	Name	Description
System.String	folderPath

View Source

CreatePartialViewMacro(IPartialView, String, Int32)

Declaration

Attempt<IPartialView> CreatePartialViewMacro(IPartialView partialView, string snippetName = null, int userId = -1)

Parameters

Type	Name	Description
IPartialView	partialView
System.String	snippetName
System.Int32	userId

Returns

Type	Description
Attempt<IPartialView>

View Source

CreatePartialViewMacroFolder(String)

Declaration

void CreatePartialViewMacroFolder(string folderPath)

Parameters

Type	Name	Description
System.String	folderPath

View Source

CreateScriptFolder(String)

Creates a folder for scripts

Declaration

void CreateScriptFolder(string folderPath)

Parameters

Type	Name	Description
System.String	folderPath

View Source

CreateStyleSheetFolder(String)

Creates a folder for style sheets

Declaration

void CreateStyleSheetFolder(string folderPath)

Parameters

Type	Name	Description
System.String	folderPath

View Source

CreateTemplateForContentType(String, String, Int32)

Creates a template for a content type

Declaration

Attempt<OperationResult<OperationResultType, ITemplate>> CreateTemplateForContentType(string contentTypeAlias, string contentTypeName, int userId = -1)

Parameters

Type	Name	Description
System.String	contentTypeAlias
System.String	contentTypeName
System.Int32	userId

Returns

Type	Description
Attempt<OperationResult<OperationResultType, ITemplate>>	The template created

View Source

CreateTemplateWithIdentity(String, String, String, ITemplate, Int32)

Declaration

ITemplate CreateTemplateWithIdentity(string name, string alias, string content, ITemplate masterTemplate = null, int userId = -1)

Parameters

Type	Name	Description
System.String	name
System.String	alias
System.String	content
ITemplate	masterTemplate
System.Int32	userId

Returns

Type	Description
ITemplate

View Source

DeletePartialView(String, Int32)

Declaration

bool DeletePartialView(string path, int userId = -1)

Parameters

Type	Name	Description
System.String	path
System.Int32	userId

Returns

Type	Description
System.Boolean

View Source

DeletePartialViewFolder(String)

Declaration

void DeletePartialViewFolder(string folderPath)

Parameters

Type	Name	Description
System.String	folderPath

View Source

DeletePartialViewMacro(String, Int32)

Declaration

bool DeletePartialViewMacro(string path, int userId = -1)

Parameters

Type	Name	Description
System.String	path
System.Int32	userId

Returns

Type	Description
System.Boolean

View Source

DeletePartialViewMacroFolder(String)

Declaration

void DeletePartialViewMacroFolder(string folderPath)

Parameters

Type	Name	Description
System.String	folderPath

View Source

DeleteScript(String, Int32)

Deletes a script by its name

Declaration

void DeleteScript(string path, int userId = -1)

Parameters

Type	Name	Description
System.String	path	Name incl. extension of the Script to delete
System.Int32	userId	Optional id of the user deleting the script

View Source

DeleteScriptFolder(String)

Deletes a folder for scripts

Declaration

void DeleteScriptFolder(string folderPath)

Parameters

Type	Name	Description
System.String	folderPath

View Source

DeleteStylesheet(String, Int32)

Deletes a stylesheet by its name

Declaration

void DeleteStylesheet(string path, int userId = -1)

Parameters

Type	Name	Description
System.String	path	Name incl. extension of the Stylesheet to delete
System.Int32	userId	Optional id of the user deleting the stylesheet

View Source

DeleteStyleSheetFolder(String)

Deletes a folder for style sheets

Declaration

void DeleteStyleSheetFolder(string folderPath)

Parameters

Type	Name	Description
System.String	folderPath

View Source

DeleteTemplate(String, Int32)

Deletes a template by its alias

Declaration

void DeleteTemplate(string alias, int userId = -1)

Parameters

Type	Name	Description
System.String	alias	Alias of the ITemplate to delete
System.Int32	userId	Optional id of the user deleting the template

View Source

GetPartialView(String)

Declaration

IPartialView GetPartialView(string path)

Parameters

Type	Name	Description
System.String	path

Returns

Type	Description
IPartialView

View Source

GetPartialViewFileContentStream(String)

Gets the content of a partial view as a stream.

Declaration

Stream GetPartialViewFileContentStream(string filepath)

Parameters

Type	Name	Description
System.String	filepath	The filesystem path to the partial view.

Returns

Type	Description
System.IO.Stream	The content of the partial view.

View Source

GetPartialViewFileSize(String)

Gets the size of a partial view.

Declaration

long GetPartialViewFileSize(string filepath)

Parameters

Type	Name	Description
System.String	filepath	The filesystem path to the partial view.

Returns

Type	Description
System.Int64	The size of the partial view.

View Source

GetPartialViewMacro(String)

Declaration

IPartialView GetPartialViewMacro(string path)

Parameters

Type	Name	Description
System.String	path

Returns

Type	Description
IPartialView

View Source

GetPartialViewMacroFileContentStream(String)

Gets the content of a macro partial view as a stream.

Declaration

Stream GetPartialViewMacroFileContentStream(string filepath)

Parameters

Type	Name	Description
System.String	filepath	The filesystem path to the macro partial view.

Returns

Type	Description
System.IO.Stream	The content of the macro partial view.

View Source

GetPartialViewMacroFileSize(String)

Gets the size of a macro partial view.

Declaration

long GetPartialViewMacroFileSize(string filepath)

Parameters

Type	Name	Description
System.String	filepath	The filesystem path to the macro partial view.

Returns

Type	Description
System.Int64	The size of the macro partial view.

View Source

GetPartialViewMacros(String[])

Declaration

IEnumerable<IPartialView> GetPartialViewMacros(params string[] names)

Parameters

Type	Name	Description
System.String[]	names

Returns

Type	Description
System.Collections.Generic.IEnumerable<IPartialView>

View Source

GetPartialViewMacroSnippetContent(String)

Gets the content of a macro partial view snippet as a string

Declaration

string GetPartialViewMacroSnippetContent(string snippetName)

Parameters

Type	Name	Description
System.String	snippetName	The name of the snippet

Returns

Type	Description
System.String

View Source

GetPartialViewSnippetContent(String)

Gets the content of a partial view snippet as a string.

Declaration

string GetPartialViewSnippetContent(string snippetName)

Parameters

Type	Name	Description
System.String	snippetName	The name of the snippet

Returns

Type	Description
System.String	The content of the partial view.

View Source

GetPartialViewSnippetNames(String[])

Declaration

IEnumerable<string> GetPartialViewSnippetNames(params string[] filterNames)

Parameters

Type	Name	Description
System.String[]	filterNames

Returns

Type	Description
System.Collections.Generic.IEnumerable<System.String>

View Source

GetScriptByName(String)

Gets a Script object by its name

Declaration

Script GetScriptByName(string name)

Parameters

Type	Name	Description
System.String	name	Name of the script incl. extension

Returns

Type	Description
Script	A Script object

View Source

GetScriptFileContentStream(String)

Gets the content of a script file as a stream.

Declaration

Stream GetScriptFileContentStream(string filepath)

Parameters

Type	Name	Description
System.String	filepath	The filesystem path to the script.

Returns

Type	Description
System.IO.Stream	The content of the script file.

View Source

GetScriptFileSize(String)

Gets the size of a script file.

Declaration

long GetScriptFileSize(string filepath)

Parameters

Type	Name	Description
System.String	filepath	The filesystem path to the script file.

Returns

Type	Description
System.Int64	The size of the script file.

View Source

GetScripts(String[])

Gets a list of all Script objects

Declaration

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

View Source

GetStylesheetByName(String)

Gets a Stylesheet object by its name

Declaration

Stylesheet GetStylesheetByName(string name)

Parameters

Type	Name	Description
System.String	name	Name of the stylesheet incl. extension

Returns

Type	Description
Stylesheet	A Stylesheet object

View Source

GetStylesheetFileContentStream(String)

Gets the content of a stylesheet as a stream.

Declaration

Stream GetStylesheetFileContentStream(string filepath)

Parameters

Type	Name	Description
System.String	filepath	The filesystem path to the stylesheet.

Returns

Type	Description
System.IO.Stream	The content of the stylesheet.

View Source

GetStylesheetFileSize(String)

Gets the size of a stylesheet.

Declaration

long GetStylesheetFileSize(string filepath)

Parameters

Type	Name	Description
System.String	filepath	The filesystem path to the stylesheet.

Returns

Type	Description
System.Int64	The size of the stylesheet.

View Source

GetStylesheets(String[])

Gets a list of all Stylesheet objects

Declaration

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

View Source

GetTemplate(Guid)

Gets a ITemplate object by its guid identifier.

Declaration

ITemplate GetTemplate(Guid id)

Parameters

Type	Name	Description
System.Guid	id	The guid identifier of the template.

Returns

Type	Description
ITemplate	The ITemplate object matching the identifier, or null.

View Source

GetTemplate(Int32)

Gets a ITemplate object by its identifier.

Declaration

ITemplate GetTemplate(int id)

Parameters

Type	Name	Description
System.Int32	id	The identifier of the template.

Returns

Type	Description
ITemplate	The ITemplate object matching the identifier, or null.

View Source

GetTemplate(String)

Gets a ITemplate object by its alias.

Declaration

ITemplate GetTemplate(string alias)

Parameters

Type	Name	Description
System.String	alias	The alias of the template.

Returns

Type	Description
ITemplate	The ITemplate object matching the alias, or null.

View Source

GetTemplateChildren(Int32)

Gets the template children

Declaration

IEnumerable<ITemplate> GetTemplateChildren(int masterTemplateId)

Parameters

Type	Name	Description
System.Int32	masterTemplateId

Returns

Type	Description
System.Collections.Generic.IEnumerable<ITemplate>

View Source

GetTemplateChildren(String)

Gets the template children

Declaration

IEnumerable<ITemplate> GetTemplateChildren(string alias)

Parameters

Type	Name	Description
System.String	alias

Returns

Type	Description
System.Collections.Generic.IEnumerable<ITemplate>

View Source

GetTemplateDescendants(Int32)

Gets the template descendants

Declaration

IEnumerable<ITemplate> GetTemplateDescendants(int masterTemplateId)

Parameters

Type	Name	Description
System.Int32	masterTemplateId

Returns

Type	Description
System.Collections.Generic.IEnumerable<ITemplate>

View Source

GetTemplateDescendants(String)

Gets the template descendants

Declaration

IEnumerable<ITemplate> GetTemplateDescendants(string alias)

Parameters

Type	Name	Description
System.String	alias

Returns

Type	Description
System.Collections.Generic.IEnumerable<ITemplate>

View Source

GetTemplateFileContentStream(String)

Gets the content of a template as a stream.

Declaration

Stream GetTemplateFileContentStream(string filepath)

Parameters

Type	Name	Description
System.String	filepath	The filesystem path to the template.

Returns

Type	Description
System.IO.Stream	The content of the template.

View Source

GetTemplateFileSize(String)

Gets the size of a template.

Declaration

long GetTemplateFileSize(string filepath)

Parameters

Type	Name	Description
System.String	filepath	The filesystem path to the template.

Returns

Type	Description
System.Int64	The size of the template.

View Source

GetTemplates(Int32)

Gets a list of all ITemplate objects

Declaration

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

View Source

GetTemplates(String[])

Gets a list of all ITemplate objects

Declaration

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

View Source

SavePartialView(IPartialView, Int32)

Declaration

Attempt<IPartialView> SavePartialView(IPartialView partialView, int userId = -1)

Parameters

Type	Name	Description
IPartialView	partialView
System.Int32	userId

Returns

Type	Description
Attempt<IPartialView>

View Source

SavePartialViewMacro(IPartialView, Int32)

Declaration

Attempt<IPartialView> SavePartialViewMacro(IPartialView partialView, int userId = -1)

Parameters

Type	Name	Description
IPartialView	partialView
System.Int32	userId

Returns

Type	Description
Attempt<IPartialView>

View Source

SaveScript(Script, Int32)

Saves a Script

Declaration

void SaveScript(Script script, int userId = -1)

Parameters

Type	Name	Description
Script	script	Script to save
System.Int32	userId	Optional id of the user saving the script

View Source

SaveStylesheet(Stylesheet, Int32)

Saves a Stylesheet

Declaration

void SaveStylesheet(Stylesheet stylesheet, int userId = -1)

Parameters

Type	Name	Description
Stylesheet	stylesheet	Stylesheet to save
System.Int32	userId	Optional id of the user saving the stylesheet

View Source

SaveTemplate(IEnumerable<ITemplate>, Int32)

Saves a collection of Template objects

Declaration

void SaveTemplate(IEnumerable<ITemplate> templates, int userId = -1)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<ITemplate>	templates	List of Template to save
System.Int32	userId	Optional id of the user

View Source

SaveTemplate(ITemplate, Int32)

Saves a ITemplate

Declaration

void SaveTemplate(ITemplate template, int userId = -1)

Parameters

Type	Name	Description
ITemplate	template	ITemplate to save
System.Int32	userId	Optional id of the user saving the template

View Source

SetPartialViewFileContent(String, Stream)

Sets the content of a partial view.

Declaration

void SetPartialViewFileContent(string filepath, Stream content)

Parameters

Type	Name	Description
System.String	filepath	The filesystem path to the partial view.
System.IO.Stream	content	The content of the partial view.

View Source

SetPartialViewMacroFileContent(String, Stream)

Sets the content of a macro partial view.

Declaration

void SetPartialViewMacroFileContent(string filepath, Stream content)

Parameters

Type	Name	Description
System.String	filepath	The filesystem path to the macro partial view.
System.IO.Stream	content	The content of the macro partial view.

View Source

SetScriptFileContent(String, Stream)

Sets the content of a script file.

Declaration

void SetScriptFileContent(string filepath, Stream content)

Parameters

Type	Name	Description
System.String	filepath	The filesystem path to the script.
System.IO.Stream	content	The content of the script file.

View Source

SetStylesheetFileContent(String, Stream)

Sets the content of a stylesheet.

Declaration

void SetStylesheetFileContent(string filepath, Stream content)

Parameters

Type	Name	Description
System.String	filepath	The filesystem path to the stylesheet.
System.IO.Stream	content	The content of the stylesheet.

View Source

SetTemplateFileContent(String, Stream)

Sets the content of a template.

Declaration

void SetTemplateFileContent(string filepath, Stream content)

Parameters

Type	Name	Description
System.String	filepath	The filesystem path to the template.
System.IO.Stream	content	The content of the template.

View Source

ValidatePartialView(PartialView)

Declaration

bool ValidatePartialView(PartialView partialView)

Parameters

Type	Name	Description
PartialView	partialView

Returns

Type	Description
System.Boolean

View Source

ValidatePartialViewMacro(PartialView)

Declaration

bool ValidatePartialViewMacro(PartialView partialView)

Parameters

Type	Name	Description
PartialView	partialView

Returns

Type	Description
System.Boolean

View Source

ValidateScript(Script)

Validates a Script

Declaration

bool ValidateScript(Script script)

Parameters

Type	Name	Description
Script	script	Script to validate

Returns

Type	Description
System.Boolean	True if Script is valid, otherwise false

View Source

ValidateStylesheet(Stylesheet)

Validates a Stylesheet

Declaration

bool ValidateStylesheet(Stylesheet stylesheet)

Parameters

Type	Name	Description
Stylesheet	stylesheet	Stylesheet to validate

Returns

Type	Description
System.Boolean	True if Stylesheet is valid, otherwise false

View Source

ValidateTemplate(ITemplate)

Validates a ITemplate

Declaration

bool ValidateTemplate(ITemplate template)

Parameters

Type	Name	Description
ITemplate	template	ITemplate to validate

Returns

Type	Description
System.Boolean	True if Script is valid, otherwise false