API Reference
EmailStoreCategoryList
Lossless Outlook master category list. Known category elements can be edited while unknown XML is preserved.
Inheritance
- Object
- EmailStoreCategoryList
Usage
Explore 3 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 3
Methods
public static EmailStoreCategoryList Create() #EmailStoreCategoryListCreates an empty category list; add at least one category before serialization.
public static EmailStoreCategoryList Parse(EmailDocument document, Int32 maxXmlBytes = 4194304) #EmailStoreCategoryListParses a category-list associated message using a strict XML byte bound.
Parameters
- document OfficeIMO.Email.EmailDocument
- maxXmlBytes System.Int32 = 4194304
public Boolean Remove(String name) #BooleanRemoves one category case-insensitively.
Parameters
- name System.String
public EmailStoreCategoryDefinition Set(String name, Int32 color = -1, UInt32 keyboardShortcut = 0, Guid? id = null, UInt32? usageCount = null, DateTimeOffset? lastUsed = null, Boolean renameOnFirstUse = false) #EmailStoreCategoryDefinitionAdds or replaces one category while retaining unknown attributes on an existing element.
Parameters
- name System.String
- color System.Int32 = -1
- keyboardShortcut System.UInt32 = 0
- id System.Guid? = null
- usageCount System.UInt32? = null
- lastUsed System.DateTimeOffset? = null
- renameOnFirstUse System.Boolean = false
public EmailDocument ToAssociatedDocument(DateTimeOffset? savedAt = null) #EmailDocumentCreates an Outlook-compatible FAI document for an associated Calendar-folder write.
Parameters
- savedAt System.DateTimeOffset? = null
public Byte[] ToXml(DateTimeOffset? savedAt = null) #Byte[]Serializes the category XML, updating its last-saved time on the serialized snapshot.
Parameters
- savedAt System.DateTimeOffset? = null
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public IReadOnlyList<EmailStoreCategoryDefinition> Categories { get; } #Every parsed category in XML order.
public String DefaultCategoryName { get; set; } #One-click default category name, or an empty string.
public DateTimeOffset? LastSavedAt { get; } #Last saved UTC time declared by the XML.
public Boolean IsProtocolEnvelopeValid { get; } #True when the known protocol envelope and required category fields are valid.