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:
Public Member Functions | |
| StockSplitEvent (DateTimeOffset paymentDate=default(DateTimeOffset), DateTimeOffset exDate=default(DateTimeOffset), UnitsRatio unitsRatio=default(UnitsRatio), DateTimeOffset? recordDate=default(DateTimeOffset?), DateTimeOffset? announcementDate=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... | |
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]
|
inlineprotected |
Initializes a new instance of the StockSplitEvent class.
◆ StockSplitEvent() [2/2]
|
inline |
Initializes a new instance of the StockSplitEvent class.
- Parameters
-
paymentDate Date on which the stock split takes effect. (required). exDate The first date on which the shares will trade at the post-split price. (required). unitsRatio unitsRatio (required). recordDate Date you have to be the holder of record in order to receive the additional shares.. announcementDate Date the stock split was announced.. 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 "StockSplitEvent").
Member Function Documentation
◆ BaseValidate()
|
inlineprotected |
To validate all properties of the instance
- Parameters
-
validationContext Validation context
- Returns
- Validation Result
◆ Equals() [1/2]
|
inline |
Returns true if objects are equal
- Parameters
-
input Object to be compared
- Returns
- Boolean
◆ Equals() [2/2]
|
inline |
Returns true if StockSplitEvent instances are equal
- Parameters
-
input Instance of StockSplitEvent to be compared
- Returns
- Boolean
◆ GetHashCode()
|
inline |
Gets the hash code
- Returns
- Hash code
◆ ToJson()
|
inlinevirtual |
Returns the JSON string presentation of the object
- Returns
- JSON string presentation of the object
Reimplemented from Lusid.Sdk.Model.InstrumentEvent.
◆ ToString()
|
inline |
Returns the string presentation of the object
- Returns
- String presentation of the object
Property Documentation
◆ AnnouncementDate
|
getset |
Date the stock split was announced.
Date the stock split was announced.
◆ ExDate
|
getset |
The first date on which the shares will trade at the post-split price.
The first date on which the shares will trade at the post-split price.
◆ PaymentDate
|
getset |
Date on which the stock split takes effect.
Date on which the stock split takes effect.
◆ RecordDate
|
getset |
Date you have to be the holder of record in order to receive the additional shares.
Date you have to be the holder of record in order to receive the additional shares.
◆ 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/StockSplitEvent.cs
