A split in the company's shares. Shareholders are given additional company shares based on the terms of the stock split. More...

Inheritance diagram for Lusid.Sdk.Model.StockSplitEvent:

[legend]

Public Member Functions
	StockSplitEvent (decimal equitySplitRatio=default(decimal), DateTimeOffset paymentDate=default(DateTimeOffset), DateTimeOffset recordDate=default(DateTimeOffset), InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum))
	Initializes a new instance of the StockSplitEvent 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 (StockSplitEvent input)
	Returns true if StockSplitEvent 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
	StockSplitEvent ()
	Initializes a new instance of the StockSplitEvent 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
decimal	EquitySplitRatio `[get, set]`
	This number describes the rate at which the company will be dividing their current shares outstanding. It is displayed as new shares per old. More...

DateTimeOffset	PaymentDate `[get, set]`
	Date on which the stock-split takes effect. More...

DateTimeOffset	RecordDate `[get, set]`
	Date you have to be the holder of record in order to participate in the tender. 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 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 }
	The Type of Event. The available values are: TransitionEvent, InformationalEvent, OpenEvent, CloseEvent, StockSplitEvent, BondDefaultEvent, CashDividendEvent, AmortisationEvent, CashFlowEvent, ExerciseEvent, ResetEvent, TriggerEvent, RawVendorEvent, InformationalErrorEvent, BondCouponEvent, DividendReinvestmentEvent More...

Detailed Description

A split in the company's shares. Shareholders are given additional company shares based on the terms of the stock split.

Constructor & Destructor Documentation

◆ StockSplitEvent() [1/2]

Lusid.Sdk.Model.StockSplitEvent.StockSplitEvent ( )

inlineprotected

Initializes a new instance of the StockSplitEvent class.

◆ StockSplitEvent() [2/2]

Lusid.Sdk.Model.StockSplitEvent.StockSplitEvent	(	decimal	equitySplitRatio = `default(decimal)`,
		DateTimeOffset	paymentDate = `default(DateTimeOffset)`,
		DateTimeOffset	recordDate = `default(DateTimeOffset)`,
		InstrumentEventTypeEnum	instrumentEventType = `default(InstrumentEventTypeEnum)`
	)

inline

Initializes a new instance of the StockSplitEvent class.

Parameters

equitySplitRatio	This number describes the rate at which the company will be dividing their current shares outstanding. It is displayed as new shares per old. (required).
paymentDate	Date on which the stock-split takes effect. (required).
recordDate	Date you have to be the holder of record in order to participate in the tender. (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 (required) (default to "StockSplitEvent").

Member Function Documentation

◆ BaseValidate()

IEnumerable<System.ComponentModel.DataAnnotations.ValidationResult> Lusid.Sdk.Model.StockSplitEvent.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.StockSplitEvent.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.StockSplitEvent.Equals ( StockSplitEvent input )

inline

Returns true if StockSplitEvent instances are equal

Parameters

input Instance of StockSplitEvent to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ EquitySplitRatio

decimal Lusid.Sdk.Model.StockSplitEvent.EquitySplitRatio

getset

This number describes the rate at which the company will be dividing their current shares outstanding. It is displayed as new shares per old.

◆ PaymentDate

DateTimeOffset Lusid.Sdk.Model.StockSplitEvent.PaymentDate

getset

Date on which the stock-split takes effect.

◆ RecordDate

DateTimeOffset Lusid.Sdk.Model.StockSplitEvent.RecordDate

getset

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

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

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ StockSplitEvent() [1/2]

◆ StockSplitEvent() [2/2]

Member Function Documentation

◆ BaseValidate()

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ EquitySplitRatio

◆ PaymentDate

◆ RecordDate