A scrip dividend issued to shareholders. More...

Inheritance diagram for Lusid.Sdk.Model.ScripDividendEvent:

[legend]

Public Member Functions
	ScripDividendEvent (DateTimeOffset? announcementDate=default(DateTimeOffset?), DateTimeOffset exDate=default(DateTimeOffset), DateTimeOffset? recordDate=default(DateTimeOffset?), DateTimeOffset paymentDate=default(DateTimeOffset), decimal? fractionalUnitsCashPrice=default(decimal?), string fractionalUnitsCashCurrency=default(string), UnitsRatio unitsRatio=default(UnitsRatio), InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum))
	Initializes a new instance of the ScripDividendEvent 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 (ScripDividendEvent input)
	Returns true if ScripDividendEvent 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
	ScripDividendEvent ()
	Initializes a new instance of the ScripDividendEvent 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...

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?	RecordDate `[get, set]`
	Date you have to be the holder of record in order to participate in the tender. More...

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

decimal?	FractionalUnitsCashPrice `[get, set]`
	The cash price per unit paid in lieu when fractional units can not be distributed. More...

string	FractionalUnitsCashCurrency `[get, set]`
	The currency of the cash paid in lieu of fractional units. More...

UnitsRatio	UnitsRatio `[get, set]`
	Gets or Sets UnitsRatio 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, CapitalDistributionEvent, SpinOffEvent, MergerEvent, FutureExpiryEvent, SwapCashFlowEvent, SwapPrincipalEvent, CreditPremiumCashFlowEvent, CdsCreditEvent, CdxCreditEvent, MbsCouponEvent, MbsPrincipalEvent, BonusIssueEvent, MbsPrincipalWriteOffEvent, MbsInterestDeferralEvent, MbsInterestShortfallEvent, TenderEvent 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 , CapitalDistributionEvent = 26 , SpinOffEvent = 27 , MergerEvent = 28 , FutureExpiryEvent = 29 , SwapCashFlowEvent = 30 , SwapPrincipalEvent = 31 , CreditPremiumCashFlowEvent = 32 , CdsCreditEvent = 33 , CdxCreditEvent = 34 , MbsCouponEvent = 35 , MbsPrincipalEvent = 36 , BonusIssueEvent = 37 , MbsPrincipalWriteOffEvent = 38 , MbsInterestDeferralEvent = 39 , MbsInterestShortfallEvent = 40 , TenderEvent = 41 }
	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, CapitalDistributionEvent, SpinOffEvent, MergerEvent, FutureExpiryEvent, SwapCashFlowEvent, SwapPrincipalEvent, CreditPremiumCashFlowEvent, CdsCreditEvent, CdxCreditEvent, MbsCouponEvent, MbsPrincipalEvent, BonusIssueEvent, MbsPrincipalWriteOffEvent, MbsInterestDeferralEvent, MbsInterestShortfallEvent, TenderEvent More...

Detailed Description

A scrip dividend issued to shareholders.

Constructor & Destructor Documentation

◆ ScripDividendEvent() [1/2]

Lusid.Sdk.Model.ScripDividendEvent.ScripDividendEvent ( )

inlineprotected

Initializes a new instance of the ScripDividendEvent class.

◆ ScripDividendEvent() [2/2]

Lusid.Sdk.Model.ScripDividendEvent.ScripDividendEvent	(	DateTimeOffset?	announcementDate = `default(DateTimeOffset?)`,
		DateTimeOffset	exDate = `default(DateTimeOffset)`,
		DateTimeOffset?	recordDate = `default(DateTimeOffset?)`,
		DateTimeOffset	paymentDate = `default(DateTimeOffset)`,
		decimal?	fractionalUnitsCashPrice = `default(decimal?)`,
		string	fractionalUnitsCashCurrency = `default(string)`,
		UnitsRatio	unitsRatio = `default(UnitsRatio)`,
		InstrumentEventTypeEnum	instrumentEventType = `default(InstrumentEventTypeEnum)`
	)

inline

Initializes a new instance of the ScripDividendEvent class.

Parameters

announcementDate	Date on which the dividend was announced / declared..
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).
recordDate	Date you have to be the holder of record in order to participate in the tender..
paymentDate	The date the company pays out dividends to shareholders. (required).
fractionalUnitsCashPrice	The cash price per unit paid in lieu when fractional units can not be distributed..
fractionalUnitsCashCurrency	The currency of the cash paid in lieu of fractional units..
unitsRatio	unitsRatio (required).
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, CapitalDistributionEvent, SpinOffEvent, MergerEvent, FutureExpiryEvent, SwapCashFlowEvent, SwapPrincipalEvent, CreditPremiumCashFlowEvent, CdsCreditEvent, CdxCreditEvent, MbsCouponEvent, MbsPrincipalEvent, BonusIssueEvent, MbsPrincipalWriteOffEvent, MbsInterestDeferralEvent, MbsInterestShortfallEvent, TenderEvent (required) (default to "ScripDividendEvent").

Member Function Documentation

◆ BaseValidate()

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

inlineprotected

To validate all properties of the instance

Parameters

validationContext Validation context

Returns: Validation Result

◆ Equals() [1/2]

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

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ Equals() [2/2]

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

inline

Returns true if ScripDividendEvent instances are equal

Parameters

input Instance of ScripDividendEvent to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

override string Lusid.Sdk.Model.ScripDividendEvent.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.ScripDividendEvent.ToString ( )

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ AnnouncementDate

DateTimeOffset? Lusid.Sdk.Model.ScripDividendEvent.AnnouncementDate

getset

Date on which the dividend was announced / declared.

◆ ExDate

DateTimeOffset Lusid.Sdk.Model.ScripDividendEvent.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.

◆ FractionalUnitsCashCurrency

string Lusid.Sdk.Model.ScripDividendEvent.FractionalUnitsCashCurrency

getset

The currency of the cash paid in lieu of fractional units.

◆ FractionalUnitsCashPrice

decimal? Lusid.Sdk.Model.ScripDividendEvent.FractionalUnitsCashPrice

getset

The cash price per unit paid in lieu when fractional units can not be distributed.

◆ PaymentDate

DateTimeOffset Lusid.Sdk.Model.ScripDividendEvent.PaymentDate

getset

The date the company pays out dividends to shareholders.

◆ RecordDate

DateTimeOffset? Lusid.Sdk.Model.ScripDividendEvent.RecordDate

getset

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

◆ UnitsRatio

UnitsRatio Lusid.Sdk.Model.ScripDividendEvent.UnitsRatio

getset

Gets or Sets UnitsRatio

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/ScripDividendEvent.cs

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ScripDividendEvent() [1/2]

◆ ScripDividendEvent() [2/2]

Member Function Documentation

◆ BaseValidate()

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ AnnouncementDate

◆ ExDate

◆ FractionalUnitsCashCurrency

◆ FractionalUnitsCashPrice

◆ PaymentDate

◆ RecordDate

◆ UnitsRatio