Get Started

API Reference

Class

ContentLineComponent

Edit on GitHub
Namespace OfficeIMO.Email
Assembly OfficeIMO.Email
Source OfficeIMO.Email/ContentLines/ContentLineComponent.cs:6
Modifiers sealed

Ordered content-line component with properties and nested components.

Inheritance

  • Object
  • ContentLineComponent

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Accepted by parameters

Constructors

public ContentLineComponent(String name) #
OfficeIMO.Email/ContentLines/ContentLineComponent.cs:6

Creates a component such as VCALENDAR, VEVENT, VALARM, or VCARD.

Parameters

name System.String requiredposition: 0

Methods

public ContentLineComponent AddComponent(String name) #
OfficeIMO.Email/ContentLines/ContentLineComponent.cs:49
Returns: ContentLineComponent

Adds a nested component and returns it.

Parameters

name System.String requiredposition: 0
public ContentLineProperty AddProperty(String name, String value = "") #
OfficeIMO.Email/ContentLines/ContentLineComponent.cs:33
Returns: ContentLineProperty

Adds a property and returns it for further configuration.

Parameters

name System.String requiredposition: 0
value System.String = "" optionalposition: 1
public IEnumerable<ContentLineComponent> GetComponents(String name, Boolean recursive = false) #
Returns: IEnumerable<ContentLineComponent>

Enumerates matching nested components in document order.

Parameters

name System.String requiredposition: 0
recursive System.Boolean = false optionalposition: 1
public ContentLineProperty GetFirstProperty(String name) #
OfficeIMO.Email/ContentLines/ContentLineComponent.cs:28
Returns: ContentLineProperty

Returns the first direct property matching name.

Parameters

name System.String requiredposition: 0
public IEnumerable<ContentLineProperty> GetProperties(String name) #
OfficeIMO.Email/ContentLines/ContentLineComponent.cs:24
Returns: IEnumerable<ContentLineProperty>

Returns all direct properties matching name.

Parameters

name System.String requiredposition: 0
public ContentLineProperty SetProperty(String name, String value) #
OfficeIMO.Email/ContentLines/ContentLineComponent.cs:40
Returns: ContentLineProperty

Replaces all matching direct properties with one value.

Parameters

name System.String requiredposition: 0
value System.String requiredposition: 1

Properties

public String Name { get; set; } #
OfficeIMO.Email/ContentLines/ContentLineComponent.cs:15

Component name.

public IList<ContentLineProperty> Properties { get; } #
OfficeIMO.Email/ContentLines/ContentLineComponent.cs:18

Ordered component properties.

public IList<ContentLineComponent> Components { get; } #
OfficeIMO.Email/ContentLines/ContentLineComponent.cs:21

Ordered nested components.

Extension Methods

public static ContentLineProperty AddRecurrenceRule(ContentLineComponent component, IcsRecurrenceRule rule) #
OfficeIMO.Email/Calendar/IcsComponentExtensions.cs:32
Returns: ContentLineProperty

Adds an RRULE property.

Parameters

component OfficeIMO.Email.ContentLineComponent requiredposition: 0
rule OfficeIMO.Email.IcsRecurrenceRule requiredposition: 1
public static ContentLineProperty AddVCardText(ContentLineComponent card, String propertyName, String value) #
OfficeIMO.Email/Contact/VCardComponentExtensions.cs:22
Returns: ContentLineProperty

Adds a repeated escaped text property.

Parameters

card OfficeIMO.Email.ContentLineComponent requiredposition: 0
propertyName System.String requiredposition: 1
value System.String requiredposition: 2
public static IEnumerable<IcsRecurrenceRule> GetRecurrenceRules(ContentLineComponent component) #
Returns: IEnumerable<IcsRecurrenceRule>

Parses every direct RRULE property.

Parameters

component OfficeIMO.Email.ContentLineComponent requiredposition: 0
public static Nullable<IcsTemporalValue> GetTemporalValue(ContentLineComponent component, String propertyName) #
OfficeIMO.Email/Calendar/IcsComponentExtensions.cs:7
Returns: Nullable<IcsTemporalValue>

Gets the first temporal property with the supplied name.

Parameters

component OfficeIMO.Email.ContentLineComponent requiredposition: 0
propertyName System.String requiredposition: 1
public static String GetVCardText(ContentLineComponent card, String propertyName) #
OfficeIMO.Email/Contact/VCardComponentExtensions.cs:7
Returns: String

Returns the first property value with vCard text escaping decoded.

Parameters

card OfficeIMO.Email.ContentLineComponent requiredposition: 0
propertyName System.String requiredposition: 1
public static ContentLineProperty SetTemporalValue(ContentLineComponent component, String propertyName, IcsTemporalValue value) #
OfficeIMO.Email/Calendar/IcsComponentExtensions.cs:16
Returns: ContentLineProperty

Creates or replaces one temporal property without resolving TZID through the host OS.

Parameters

component OfficeIMO.Email.ContentLineComponent requiredposition: 0
propertyName System.String requiredposition: 1
value OfficeIMO.Email.IcsTemporalValue requiredposition: 2
public static ContentLineProperty SetVCardText(ContentLineComponent card, String propertyName, String value) #
OfficeIMO.Email/Contact/VCardComponentExtensions.cs:15
Returns: ContentLineProperty

Creates or replaces one escaped text property.

Parameters

card OfficeIMO.Email.ContentLineComponent requiredposition: 0
propertyName System.String requiredposition: 1
value System.String requiredposition: 2