# BookOnixCollection

Explicit membership in one collection or named grouping. Does not infer ONIX semantics from EPUB series metadata.

Class 

`OfficeIMO.Workflows`

**Namespace**

`OfficeIMO.Workflows`

**Assembly**

`OfficeIMO.Workflows`

**Source revision**

`3b680b1b6fb1` with working tree changes

**Source**

[BookOnixCollection.cs:84](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Workflows/Publishing/BookOnixCollection.cs#L84)

**Implements**

`IEquatable<BookOnixCollection>`

**Modifiers**

sealed

Explicit membership in one collection or named grouping. Does not infer ONIX semantics from EPUB series metadata.

## Inheritance

- object
- BookOnixCollection

## Usage

Explore 7 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 2

- Method [BookOnixCollection.<Clone>$](/api/workflows/officeimo-workflows-bookonixcollection/#method-clone)
- Property [BookOnixExportOptions.Collections](/api/workflows/officeimo-workflows-bookonixexportoptions/#property-collections)

### Accepted by parameters 5

- Method [BookOnixCollection.Equals](/api/workflows/officeimo-workflows-bookonixcollection/#method-equals-bookonixcollection) parameter `other`
- Method [BookOnixCollection.op_Equality](/api/workflows/officeimo-workflows-bookonixcollection/#method-op-equality-bookonixcollection-bookonixcollection) parameter `left`
- Method [BookOnixCollection.op_Equality](/api/workflows/officeimo-workflows-bookonixcollection/#method-op-equality-bookonixcollection-bookonixcollection) parameter `right`
- Method [BookOnixCollection.op_Inequality](/api/workflows/officeimo-workflows-bookonixcollection/#method-op-inequality-bookonixcollection-bookonixcollection) parameter `left`
- Method [BookOnixCollection.op_Inequality](/api/workflows/officeimo-workflows-bookonixcollection/#method-op-inequality-bookonixcollection-bookonixcollection) parameter `right`

Filter members 

Show inherited

## Constructors

`public BookOnixCollection()` [#](#constructor-ctor)

[BookOnixCollection.cs:84](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Workflows/Publishing/BookOnixCollection.cs#L84)

`Obsolete("Constructors of types with required members are not supported in this version of your compiler.", true)`

## Methods

`public BookOnixCollection <Clone>$()` [#](#method-clone)

Returns

`BookOnixCollection`

Equals 2 overloads

`public override bool Equals(object? obj)` [#](#method-equals-object)

Parameters

**obj object? required**

Returns

`bool`

`public bool Equals(BookOnixCollection? other)` [#](#method-equals-bookonixcollection)

Parameters

**other BookOnixCollection? required**

Returns

`bool`

`public override int GetHashCode()` [#](#method-gethashcode)

Returns

`int`

`public static bool op_Equality(BookOnixCollection? left, BookOnixCollection? right)` [#](#method-op-equality-bookonixcollection-bookonixcollection)

Parameters

**left BookOnixCollection? required**

**right BookOnixCollection? required**

Returns

`bool`

`public static bool op_Inequality(BookOnixCollection? left, BookOnixCollection? right)` [#](#method-op-inequality-bookonixcollection-bookonixcollection)

Parameters

**left BookOnixCollection? required**

**right BookOnixCollection? required**

Returns

`bool`

`public override string ToString()` [#](#method-tostring)

Returns

`string`

## Inherited Methods

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

## Properties

`public BookOnixCollectionType Type { get; init; }` [#](#property-type)

[BookOnixCollection.cs:74](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Workflows/Publishing/BookOnixCollection.cs#L74)

Who defines the collection.

`public string? Title { get; init; }` [#](#property-title)

[BookOnixCollection.cs:76](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Workflows/Publishing/BookOnixCollection.cs#L76)

Simple top-level collection title, separate from the product title. Mutually exclusive with TitleElements.

`public BookOnixTitleSorting? TitleSorting { get; init; }` [#](#property-titlesorting)

[BookOnixCollection.cs:78](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Workflows/Publishing/BookOnixCollection.cs#L78)

Optional explicit sorting prefix or no-prefix assertion; omission retains unsplit TitleText.

`public string? Subtitle { get; init; }` [#](#property-subtitle)

[BookOnixCollection.cs:80](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Workflows/Publishing/BookOnixCollection.cs#L80)

Optional subtitle of the collection.

`public string? LanguageCode { get; init; }` [#](#property-languagecode)

[BookOnixCollection.cs:82](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Workflows/Publishing/BookOnixCollection.cs#L82)

Optional ONIX list 74 language for the collection title and subtitle.

`public IReadOnlyList<BookOnixCollectionTitleElement> TitleElements { get; init; }` [#](#property-titleelements)

[BookOnixCollection.cs:84](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Workflows/Publishing/BookOnixCollection.cs#L84)

One to five title elements in display order, with one per level. Mutually exclusive with Title, Subtitle, LanguageCode and TitleSorting.

`public BookOnixCollectionFrequency? Frequency { get; init; }` [#](#property-frequency)

[BookOnixCollection.cs:86](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Workflows/Publishing/BookOnixCollection.cs#L86)

Optional explicit frequency of publication of successive products in the collection.

`public string? SourceName { get; init; }` [#](#property-sourcename)

[BookOnixCollection.cs:88](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Workflows/Publishing/BookOnixCollection.cs#L88)

Source of an ascribed collection; required for Ascribed and optional otherwise.

`public IReadOnlyList<BookOnixCollectionIdentifier> Identifiers { get; init; }` [#](#property-identifiers)

[BookOnixCollection.cs:90](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Workflows/Publishing/BookOnixCollection.cs#L90)

Up to 16 identifiers; at most one value per level, type and proprietary scheme name. Unscoped and scoped values for the same scheme cannot coexist.

`public IReadOnlyList<BookOnixCollectionSequence> Sequences { get; init; }` [#](#property-sequences)

[BookOnixCollection.cs:92](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Workflows/Publishing/BookOnixCollection.cs#L92)

Up to 16 positions; at most one per type and proprietary sequence name.

`public IReadOnlyList<BookOnixContributor> Contributors { get; init; }` [#](#property-contributors)

[BookOnixCollection.cs:94](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Workflows/Publishing/BookOnixCollection.cs#L94)

Up to 100 ordered collection credits, independent of product credits. Empty makes no assertion.

`public bool NoContributors { get; init; }` [#](#property-nocontributors)

[BookOnixCollection.cs:96](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Workflows/Publishing/BookOnixCollection.cs#L96)

Explicit assertion of no collection contributors; mutually exclusive with Contributors.

<!-- PowerForge markdown artifact sha256:788F1602DB2402E2B9287C7646A746B525505FCADA16931A8710830B08E966CC -->
