LUSID C# SDK
Public Member Functions | Protected Member Functions | Properties | List of all members
Lusid.Sdk.Model.StockDividendEvent Class Reference

A payment to shareholders that consists of additional shares rather than cash. More...

Inheritance diagram for Lusid.Sdk.Model.StockDividendEvent:
Inheritance graph
[legend]

Public Member Functions

 StockDividendEvent (DateTimeOffset? announcementDate=default(DateTimeOffset?), DateTimeOffset exDate=default(DateTimeOffset), DateTimeOffset paymentDate=default(DateTimeOffset), DateTimeOffset? recordDate=default(DateTimeOffset?), UnitsRatio unitsRatio=default(UnitsRatio), InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum))
 Initializes a new instance of the StockDividendEvent 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 (StockDividendEvent input)
 Returns true if StockDividendEvent 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

 StockDividendEvent ()
 Initializes a new instance of the StockDividendEvent 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 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...
 
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 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
}
 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 More...
 

Detailed Description

A payment to shareholders that consists of additional shares rather than cash.

Constructor & Destructor Documentation

◆ StockDividendEvent() [1/2]

Lusid.Sdk.Model.StockDividendEvent.StockDividendEvent ( )
inlineprotected

Initializes a new instance of the StockDividendEvent class.

◆ StockDividendEvent() [2/2]

Lusid.Sdk.Model.StockDividendEvent.StockDividendEvent ( DateTimeOffset?  announcementDate = default(DateTimeOffset?),
DateTimeOffset  exDate = default(DateTimeOffset),
DateTimeOffset  paymentDate = default(DateTimeOffset),
DateTimeOffset?  recordDate = default(DateTimeOffset?),
UnitsRatio  unitsRatio = default(UnitsRatio),
InstrumentEventTypeEnum  instrumentEventType = default(InstrumentEventTypeEnum) 
)
inline

Initializes a new instance of the StockDividendEvent class.

Parameters
announcementDateDate on which the dividend was announced / declared..
exDateThe first business day on which the dividend is not owed to the buying party. Typically this is T-1 from the RecordDate. (required).
paymentDateThe date the company pays out dividends to shareholders. (required).
recordDateDate you have to be the holder of record in order to participate in the tender..
unitsRatiounitsRatio (required).
instrumentEventTypeThe 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 (required) (default to "StockDividendEvent").

Member Function Documentation

◆ BaseValidate()

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

To validate all properties of the instance

Parameters
validationContextValidation context
Returns
Validation Result

◆ Equals() [1/2]

override bool Lusid.Sdk.Model.StockDividendEvent.Equals ( object  input)
inline

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ Equals() [2/2]

bool Lusid.Sdk.Model.StockDividendEvent.Equals ( StockDividendEvent  input)
inline

Returns true if StockDividendEvent instances are equal

Parameters
inputInstance of StockDividendEvent to be compared
Returns
Boolean

◆ GetHashCode()

override int Lusid.Sdk.Model.StockDividendEvent.GetHashCode ( )
inline

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AnnouncementDate

DateTimeOffset? Lusid.Sdk.Model.StockDividendEvent.AnnouncementDate
getset

Date on which the dividend was announced / declared.

Date on which the dividend was announced / declared.

◆ ExDate

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

DateTimeOffset Lusid.Sdk.Model.StockDividendEvent.PaymentDate
getset

The date the company pays out dividends to shareholders.

The date the company pays out dividends to shareholders.

◆ RecordDate

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

UnitsRatio Lusid.Sdk.Model.StockDividendEvent.UnitsRatio
getset

Gets or Sets UnitsRatio


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