Search Results for

    Show / Hide Table of Contents
    View Source

    Interface IEntityXmlSerializer

    Serializes entities to XML

    Namespace: Umbraco.Cms.Core.Services
    Assembly: Umbraco.Core.dll
    Syntax
    public interface IEntityXmlSerializer

    Methods

    View Source

    Serialize(IEnumerable<IDataType>)

    Exports a list of Data Types

    Declaration
    XElement Serialize(IEnumerable<IDataType> dataTypeDefinitions)
    Parameters
    Type Name Description
    IEnumerable<IDataType> dataTypeDefinitions

    List of data types to export

    Returns
    Type Description
    System.Xml.Linq.XElement

    System.Xml.Linq.XElement containing the xml representation of the IDataTypeDefinition objects

    View Source

    Serialize(IEnumerable<IDictionaryItem>, Boolean)

    Exports a list of IDictionaryItem items to xml as an System.Xml.Linq.XElement

    Declaration
    XElement Serialize(IEnumerable<IDictionaryItem> dictionaryItem, bool includeChildren = true)
    Parameters
    Type Name Description
    IEnumerable<IDictionaryItem> dictionaryItem

    List of dictionary items to export

    System.Boolean includeChildren

    Optional boolean indicating whether or not to include children

    Returns
    Type Description
    System.Xml.Linq.XElement

    System.Xml.Linq.XElement containing the xml representation of the IDictionaryItem objects

    View Source

    Serialize(IEnumerable<ILanguage>)

    Exports a list of ILanguage items to xml as an System.Xml.Linq.XElement

    Declaration
    XElement Serialize(IEnumerable<ILanguage> languages)
    Parameters
    Type Name Description
    IEnumerable<ILanguage> languages

    List of Languages to export

    Returns
    Type Description
    System.Xml.Linq.XElement

    System.Xml.Linq.XElement containing the xml representation of the ILanguage objects

    View Source

    Serialize(IEnumerable<IMacro>)

    Exports a list of IMacro items to xml as an System.Xml.Linq.XElement

    Declaration
    XElement Serialize(IEnumerable<IMacro> macros)
    Parameters
    Type Name Description
    IEnumerable<IMacro> macros

    Macros to export

    Returns
    Type Description
    System.Xml.Linq.XElement

    System.Xml.Linq.XElement containing the xml representation of the IMacro objects

    View Source

    Serialize(IEnumerable<ITemplate>)

    Exports a list of ITemplate items to xml as an System.Xml.Linq.XElement

    Declaration
    XElement Serialize(IEnumerable<ITemplate> templates)
    Parameters
    Type Name Description
    IEnumerable<ITemplate> templates
    Returns
    Type Description
    System.Xml.Linq.XElement
    View Source

    Serialize(IContent, Boolean, Boolean)

    Exports an IContent item as an XElement.

    Declaration
    XElement Serialize(IContent content, bool published, bool withDescendants = false)
    Parameters
    Type Name Description
    IContent content
    System.Boolean published
    System.Boolean withDescendants
    Returns
    Type Description
    System.Xml.Linq.XElement
    View Source

    Serialize(IContentType)

    Declaration
    XElement Serialize(IContentType contentType)
    Parameters
    Type Name Description
    IContentType contentType
    Returns
    Type Description
    System.Xml.Linq.XElement
    View Source

    Serialize(IDataType)

    Declaration
    XElement Serialize(IDataType dataType)
    Parameters
    Type Name Description
    IDataType dataType
    Returns
    Type Description
    System.Xml.Linq.XElement
    View Source

    Serialize(IDictionaryItem, Boolean)

    Exports a single IDictionaryItem item to xml as an System.Xml.Linq.XElement

    Declaration
    XElement Serialize(IDictionaryItem dictionaryItem, bool includeChildren)
    Parameters
    Type Name Description
    IDictionaryItem dictionaryItem

    Dictionary Item to export

    System.Boolean includeChildren

    Optional boolean indicating whether or not to include children

    Returns
    Type Description
    System.Xml.Linq.XElement

    System.Xml.Linq.XElement containing the xml representation of the IDictionaryItem object

    View Source

    Serialize(ILanguage)

    Declaration
    XElement Serialize(ILanguage language)
    Parameters
    Type Name Description
    ILanguage language
    Returns
    Type Description
    System.Xml.Linq.XElement
    View Source

    Serialize(IMacro)

    Declaration
    XElement Serialize(IMacro macro)
    Parameters
    Type Name Description
    IMacro macro
    Returns
    Type Description
    System.Xml.Linq.XElement
    View Source

    Serialize(IMedia, Boolean, Nullable<Action<IMedia, XElement>>)

    Exports an IMedia item as an XElement.

    Declaration
    XElement Serialize(IMedia media, bool withDescendants = false, Action<IMedia, XElement>? onMediaItemSerialized = null)
    Parameters
    Type Name Description
    IMedia media
    System.Boolean withDescendants
    System.Nullable<Action<IMedia, System.Xml.Linq.XElement>> onMediaItemSerialized
    Returns
    Type Description
    System.Xml.Linq.XElement
    View Source

    Serialize(IMediaType)

    Declaration
    XElement Serialize(IMediaType mediaType)
    Parameters
    Type Name Description
    IMediaType mediaType
    Returns
    Type Description
    System.Xml.Linq.XElement
    View Source

    Serialize(IMember)

    Exports an IMember item as an XElement.

    Declaration
    XElement Serialize(IMember member)
    Parameters
    Type Name Description
    IMember member
    Returns
    Type Description
    System.Xml.Linq.XElement
    View Source

    Serialize(IStylesheet, Boolean)

    Declaration
    XElement Serialize(IStylesheet stylesheet, bool includeProperties)
    Parameters
    Type Name Description
    IStylesheet stylesheet
    System.Boolean includeProperties
    Returns
    Type Description
    System.Xml.Linq.XElement
    View Source

    Serialize(ITemplate)

    Declaration
    XElement Serialize(ITemplate template)
    Parameters
    Type Name Description
    ITemplate template
    Returns
    Type Description
    System.Xml.Linq.XElement
    • Improve this Doc
    • View Source
    In This Article
    • Methods
      • Serialize(IEnumerable<IDataType>)
      • Serialize(IEnumerable<IDictionaryItem>, Boolean)
      • Serialize(IEnumerable<ILanguage>)
      • Serialize(IEnumerable<IMacro>)
      • Serialize(IEnumerable<ITemplate>)
      • Serialize(IContent, Boolean, Boolean)
      • Serialize(IContentType)
      • Serialize(IDataType)
      • Serialize(IDictionaryItem, Boolean)
      • Serialize(ILanguage)
      • Serialize(IMacro)
      • Serialize(IMedia, Boolean, Nullable<Action<IMedia, XElement>>)
      • Serialize(IMediaType)
      • Serialize(IMember)
      • Serialize(IStylesheet, Boolean)
      • Serialize(ITemplate)
    Back to top Copyright © 2016-present Umbraco
    Generated by DocFX