Inheritance diagram for Lusid.Sdk.Model.DividendOptionEvent:

[legend]

Public Member Functions
	DividendOptionEvent (DateTimeOffset? announcementDate=default(DateTimeOffset?), List< CashElection > cashElections=default(List< CashElection >), DateTimeOffset exDate=default(DateTimeOffset), DateTimeOffset paymentDate=default(DateTimeOffset), DateTimeOffset? recordDate=default(DateTimeOffset?), List< SecurityElection > securityElections=default(List< SecurityElection >), DateTimeOffset securitySettlementDate=default(DateTimeOffset), InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum))
	Initializes a new instance of the DividendOptionEvent class. More...

override string	ToString ()
	Returns the string presentation of the object More...

override string	ToJson ()
	Returns the JSON string presentation of the object More...

override bool	Equals (object input)
	Returns true if objects are equal More...

bool	Equals (DividendOptionEvent input)
	Returns true if DividendOptionEvent instances are equal More...

override int	GetHashCode ()
	Gets the hash code More...

Public Member Functions inherited from Lusid.Sdk.Model.InstrumentEvent
	InstrumentEvent (InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum))
	Initializes a new instance of the InstrumentEvent class. More...

override string	ToString ()
	Returns the string presentation of the object More...

override bool	Equals (object input)
	Returns true if objects are equal More...

bool	Equals (InstrumentEvent input)
	Returns true if InstrumentEvent instances are equal More...

override int	GetHashCode ()
	Gets the hash code More...

Protected Member Functions
	DividendOptionEvent ()
	Initializes a new instance of the DividendOptionEvent class. More...

IEnumerable< System.ComponentModel.DataAnnotations.ValidationResult >	BaseValidate (ValidationContext validationContext)
	To validate all properties of the instance More...

Protected Member Functions inherited from Lusid.Sdk.Model.InstrumentEvent
	InstrumentEvent ()
	Initializes a new instance of the InstrumentEvent class. More...

IEnumerable< System.ComponentModel.DataAnnotations.ValidationResult >	BaseValidate (ValidationContext validationContext)
	To validate all properties of the instance More...

Properties
DateTimeOffset?	AnnouncementDate `[get, set]`
	Date on which the dividend was announced / declared. More...

List< CashElection >	CashElections `[get, set]`
	CashElection for this DividendReinvestmentEvent More...

DateTimeOffset	ExDate `[get, set]`
	The first business day on which the dividend is not owed to the buying party. Typically this is T-1 from the RecordDate. More...

DateTimeOffset	PaymentDate `[get, set]`
	The date the company pays out dividends to shareholders. More...

DateTimeOffset?	RecordDate `[get, set]`
	Date you have to be the holder of record in order to participate in the tender. More...

List< SecurityElection >	SecurityElections `[get, set]`
	SecurityElection for this DividendReinvestmentEvent More...

DateTimeOffset	SecuritySettlementDate `[get, set]`
	The settlement date of the additional units. Equal to the PaymentDate if not provided. More...

Properties inherited from Lusid.Sdk.Model.InstrumentEvent
InstrumentEventTypeEnum	InstrumentEventType `[get, set]`
	The Type of Event. The available values are: TransitionEvent, InformationalEvent, OpenEvent, CloseEvent, StockSplitEvent, BondDefaultEvent, CashDividendEvent, AmortisationEvent, CashFlowEvent, ExerciseEvent, ResetEvent, TriggerEvent, RawVendorEvent, InformationalErrorEvent, BondCouponEvent, DividendReinvestmentEvent, AccumulationEvent, BondPrincipalEvent, DividendOptionEvent, MaturityEvent, FxForwardSettlementEvent, ExpiryEvent, ScripDividendEvent, StockDividendEvent, ReverseStockSplitEvent More...

Additional Inherited Members
Public Types inherited from Lusid.Sdk.Model.InstrumentEvent
enum class	InstrumentEventTypeEnum { TransitionEvent = 1 , InformationalEvent = 2 , OpenEvent = 3 , CloseEvent = 4 , StockSplitEvent = 5 , BondDefaultEvent = 6 , CashDividendEvent = 7 , AmortisationEvent = 8 , CashFlowEvent = 9 , ExerciseEvent = 10 , ResetEvent = 11 , TriggerEvent = 12 , RawVendorEvent = 13 , InformationalErrorEvent = 14 , BondCouponEvent = 15 , DividendReinvestmentEvent = 16 , AccumulationEvent = 17 , BondPrincipalEvent = 18 , DividendOptionEvent = 19 , MaturityEvent = 20 , FxForwardSettlementEvent = 21 , ExpiryEvent = 22 , ScripDividendEvent = 23 , StockDividendEvent = 24 , ReverseStockSplitEvent = 25 }
	The Type of Event. The available values are: TransitionEvent, InformationalEvent, OpenEvent, CloseEvent, StockSplitEvent, BondDefaultEvent, CashDividendEvent, AmortisationEvent, CashFlowEvent, ExerciseEvent, ResetEvent, TriggerEvent, RawVendorEvent, InformationalErrorEvent, BondCouponEvent, DividendReinvestmentEvent, AccumulationEvent, BondPrincipalEvent, DividendOptionEvent, MaturityEvent, FxForwardSettlementEvent, ExpiryEvent, ScripDividendEvent, StockDividendEvent, ReverseStockSplitEvent More...

Detailed Description

DVOP

Constructor & Destructor Documentation

◆ DividendOptionEvent() [1/2]

Lusid.Sdk.Model.DividendOptionEvent.DividendOptionEvent ( )

inlineprotected

Initializes a new instance of the DividendOptionEvent class.

◆ DividendOptionEvent() [2/2]

Lusid.Sdk.Model.DividendOptionEvent.DividendOptionEvent	(	DateTimeOffset?	announcementDate = `default(DateTimeOffset?)`,
		List< CashElection >	cashElections = `default(List<CashElection>)`,
		DateTimeOffset	exDate = `default(DateTimeOffset)`,
		DateTimeOffset	paymentDate = `default(DateTimeOffset)`,
		DateTimeOffset?	recordDate = `default(DateTimeOffset?)`,
		List< SecurityElection >	securityElections = `default(List<SecurityElection>)`,
		DateTimeOffset	securitySettlementDate = `default(DateTimeOffset)`,
		InstrumentEventTypeEnum	instrumentEventType = `default(InstrumentEventTypeEnum)`
	)

inline

Initializes a new instance of the DividendOptionEvent class.

Parameters

announcementDate	Date on which the dividend was announced / declared..
cashElections	CashElection for this DividendReinvestmentEvent (required).
exDate	The first business day on which the dividend is not owed to the buying party. Typically this is T-1 from the RecordDate. (required).
paymentDate	The date the company pays out dividends to shareholders. (required).
recordDate	Date you have to be the holder of record in order to participate in the tender..
securityElections	SecurityElection for this DividendReinvestmentEvent (required).
securitySettlementDate	The settlement date of the additional units. Equal to the PaymentDate if not provided..
instrumentEventType	The Type of Event. The available values are: TransitionEvent, InformationalEvent, OpenEvent, CloseEvent, StockSplitEvent, BondDefaultEvent, CashDividendEvent, AmortisationEvent, CashFlowEvent, ExerciseEvent, ResetEvent, TriggerEvent, RawVendorEvent, InformationalErrorEvent, BondCouponEvent, DividendReinvestmentEvent, AccumulationEvent, BondPrincipalEvent, DividendOptionEvent, MaturityEvent, FxForwardSettlementEvent, ExpiryEvent, ScripDividendEvent, StockDividendEvent, ReverseStockSplitEvent (required) (default to "DividendOptionEvent").

Member Function Documentation

◆ BaseValidate()

IEnumerable<System.ComponentModel.DataAnnotations.ValidationResult> Lusid.Sdk.Model.DividendOptionEvent.BaseValidate ( ValidationContext validationContext )

inlineprotected

To validate all properties of the instance

Parameters

validationContext Validation context

Returns: Validation Result

◆ Equals() [1/2]

bool Lusid.Sdk.Model.DividendOptionEvent.Equals ( DividendOptionEvent input )

inline

Returns true if DividendOptionEvent instances are equal

Parameters

input Instance of DividendOptionEvent to be compared

Returns: Boolean

◆ Equals() [2/2]

override bool Lusid.Sdk.Model.DividendOptionEvent.Equals ( object input )

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ GetHashCode()

override int Lusid.Sdk.Model.DividendOptionEvent.GetHashCode ( )

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

override string Lusid.Sdk.Model.DividendOptionEvent.ToJson ( )

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

Reimplemented from Lusid.Sdk.Model.InstrumentEvent.

◆ ToString()

override string Lusid.Sdk.Model.DividendOptionEvent.ToString ( )

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ AnnouncementDate

DateTimeOffset? Lusid.Sdk.Model.DividendOptionEvent.AnnouncementDate

getset

Date on which the dividend was announced / declared.

◆ CashElections

List<CashElection> Lusid.Sdk.Model.DividendOptionEvent.CashElections

getset

CashElection for this DividendReinvestmentEvent

◆ ExDate

DateTimeOffset Lusid.Sdk.Model.DividendOptionEvent.ExDate

getset

The first business day on which the dividend is not owed to the buying party. Typically this is T-1 from the RecordDate.

◆ PaymentDate

DateTimeOffset Lusid.Sdk.Model.DividendOptionEvent.PaymentDate

getset

The date the company pays out dividends to shareholders.

◆ RecordDate

DateTimeOffset? Lusid.Sdk.Model.DividendOptionEvent.RecordDate

getset

Date you have to be the holder of record in order to participate in the tender.

◆ SecurityElections

List<SecurityElection> Lusid.Sdk.Model.DividendOptionEvent.SecurityElections

getset

SecurityElection for this DividendReinvestmentEvent

◆ SecuritySettlementDate

DateTimeOffset Lusid.Sdk.Model.DividendOptionEvent.SecuritySettlementDate

getset

The settlement date of the additional units. Equal to the PaymentDate if not provided.

The documentation for this class was generated from the following file:

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Model/DividendOptionEvent.cs

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DividendOptionEvent() [1/2]

◆ DividendOptionEvent() [2/2]

Member Function Documentation

◆ BaseValidate()

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ AnnouncementDate

◆ CashElections

◆ ExDate

◆ PaymentDate

◆ RecordDate

◆ SecurityElections

◆ SecuritySettlementDate