A scrip dividend issued to shareholders. More...
Inheritance diagram for Lusid.Sdk.Model.ScripDividendEvent:
Public Member Functions | |
| ScripDividendEvent (DateTimeOffset? announcementDate=default(DateTimeOffset?), DateTimeOffset exDate=default(DateTimeOffset), DateTimeOffset? recordDate=default(DateTimeOffset?), DateTimeOffset paymentDate=default(DateTimeOffset), 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... | |
| 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 More... | |
Detailed Description
A scrip dividend issued to shareholders.
Constructor & Destructor Documentation
◆ ScripDividendEvent() [1/2]
|
inlineprotected |
Initializes a new instance of the ScripDividendEvent class.
◆ ScripDividendEvent() [2/2]
|
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). 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 (required) (default to "ScripDividendEvent").
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 ScripDividendEvent instances are equal
- Parameters
-
input Instance of ScripDividendEvent 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 on which the dividend was announced / declared.
Date on which the dividend was announced / declared.
◆ 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.
The first business day on which the dividend is not owed to the buying party. Typically this is T-1 from the RecordDate.
◆ PaymentDate
|
getset |
The date the company pays out dividends to shareholders.
The date the company pays out dividends to shareholders.
◆ RecordDate
|
getset |
Date you have to be the holder of record in order to participate in the tender.
Date you have to be the holder of record in order to participate in the tender.
◆ 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
