This documentation is archived and is not being maintained.

CategoriesDocumentFormatter Class

An abstract class used as a base class for other formatters, (for example, AtomPub10CategoriesDocumentFormatter).


Namespace:  System.ServiceModel.Syndication
Assembly:  System.ServiceModel (in System.ServiceModel.dll)

public ref class CategoriesDocumentFormatter abstract

The CategoriesDocumentFormatter type exposes the following members.

Protected methodCategoriesDocumentFormatter()Creates a new instance of the CategoriesDocumentFormatter class.
Protected methodCategoriesDocumentFormatter(CategoriesDocument)Creates a new instance of the CategoriesDocumentFormatter class with the specified CategoriesDocument.

Public propertyDocumentGets the categories document.
Public propertyVersionGets the syndication version used by the formatter.

Public methodCanReadVerifies whether the specified XmlReader contains a valid Atom 1.0 categories document.
Protected methodCreateInlineCategoriesDocumentCreates a InlineCategoriesDocument that can be serialized into a <atom:categories> element within a service document and contains the set of categories within the element.
Protected methodCreateReferencedCategoriesDocumentCreates a ReferencedCategoriesDocument that can be serialized into a <atom:categories> element within a service document and contains a URI reference to the set of categories within the element.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodReadFromReads an Atom 1.0 <atom:categories> element from the specified XmlReader instance.
Protected methodSetDocumentSpecifies the CategoriesDocument to associate with the CategoriesDocumentFormatter.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodWriteToWrites the CategoriesDocument associated with the CategoriesDocumentFormatter to the specified XmlWriter.

This class is abstract and cannot be instantiated directly.

.NET Framework

Supported in: 4, 3.5 SP1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.