Hierarchy

Hierarchy

Constructors

  • Parameters

    Returns IgrXCalendar

Properties

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>
props: Readonly<IIgrXCalendarProps> & Readonly<{
    children?: ReactNode;
}>
refs: {
    [key: string]: ReactInstance;
}

Type declaration

  • [key: string]: ReactInstance
state: Readonly<{}>
contextType?: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
static contextType = Ctx
context!: React.ContextType<typeof Ctx>
render () {
return <>My context's value: {this.context}</>;
}
}

Accessors

  • get backgroundColor(): string
  • Gets or Sets the selected date background color

    Returns string

  • set backgroundColor(v): void
  • Parameters

    • v: string

    Returns void

  • get baseTheme(): BaseControlTheme
  • Gets or sets the base built in theme to use for the calendar.

    Returns BaseControlTheme

  • set baseTheme(v): void
  • Parameters

    • v: BaseControlTheme

    Returns void

  • get currentDateBorderColor(): string
  • Gets or Sets the current date text color

    Returns string

  • set currentDateBorderColor(v): void
  • Parameters

    • v: string

    Returns void

  • get currentDateTextColor(): string
  • Gets or Sets the current date text color

    Returns string

  • set currentDateTextColor(v): void
  • Parameters

    • v: string

    Returns void

  • get density(): ControlDisplayDensity
  • Gets or sets the display density to use for the calendar.

    Returns ControlDisplayDensity

  • set density(v): void
  • Parameters

    • v: ControlDisplayDensity

    Returns void

  • get firstDayOfWeek(): DayOfWeek
  • Gets or sets the FirstDayOfWeek property to detirmine first day of the week

    Returns DayOfWeek

  • set firstDayOfWeek(v): void
  • Parameters

    Returns void

  • get firstWeekOfYear(): FirstWeek
  • Gets or sets the FirstWeekOfYear property to detirmine first week of the year

    Returns FirstWeek

  • set firstWeekOfYear(v): void
  • Parameters

    Returns void

  • get focusDateBackgroundColor(): string
  • Gets or Sets the focus date background color

    Returns string

  • set focusDateBackgroundColor(v): void
  • Parameters

    • v: string

    Returns void

  • get focusDateTextColor(): string
  • Gets or Sets the focus date text color

    Returns string

  • set focusDateTextColor(v): void
  • Parameters

    • v: string

    Returns void

  • get height(): string
  • Returns string

  • set height(value): void
  • Parameters

    • value: string

    Returns void

  • get hoverBackgroundColor(): string
  • Gets or Sets the focus date background color

    Returns string

  • set hoverBackgroundColor(v): void
  • Parameters

    • v: string

    Returns void

  • get i(): XCalendar
  • Returns XCalendar

  • get maxDate(): Date
  • Gets or Sets the property name that contains the MaxDate.

    Returns Date

  • set maxDate(v): void
  • Parameters

    • v: Date

    Returns void

  • get minDate(): Date
  • Gets or Sets the property name that contains the MinDate.

    Returns Date

  • set minDate(v): void
  • Parameters

    • v: Date

    Returns void

  • get selectedDateBackgroundColor(): string
  • Gets or Sets the selected date background color

    Returns string

  • set selectedDateBackgroundColor(v): void
  • Parameters

    • v: string

    Returns void

  • get selectedDateTextColor(): string
  • Gets or Sets the selected date text color

    Returns string

  • set selectedDateTextColor(v): void
  • Parameters

    • v: string

    Returns void

  • get selectedFocusDateBackgroundColor(): string
  • Gets or Sets the selected date background color

    Returns string

  • set selectedFocusDateBackgroundColor(v): void
  • Parameters

    • v: string

    Returns void

  • get selectedValueChanged(): ((s, e) => void)
  • Called when date is selected.

    Returns ((s, e) => void)

  • set selectedValueChanged(ev): void
  • Parameters

    Returns void

  • get showTodayButton(): boolean
  • Gets or sets the ShowTodayButton property to detirmine if the today button is shown

    Returns boolean

  • set showTodayButton(v): void
  • Parameters

    • v: boolean

    Returns void

  • get showWeekNumbers(): boolean
  • Gets or sets the ShowWeekNumbers property to detirmine if the week numbers are shown

    Returns boolean

  • set showWeekNumbers(v): void
  • Parameters

    • v: boolean

    Returns void

  • get textColor(): string
  • Gets or Sets the selected date text color

    Returns string

  • set textColor(v): void
  • Parameters

    • v: string

    Returns void

  • get textStyle(): string
  • Gets or sets the font to use for the combobox.

    Returns string

  • set textStyle(v): void
  • Parameters

    • v: string

    Returns void

  • get today(): Date
  • Gets or Sets the property name that contains the values.

    Returns Date

  • set today(v): void
  • Parameters

    • v: Date

    Returns void

  • get value(): Date
  • Gets or Sets the value for the calendar.

    Returns Date

  • set value(v): void
  • Parameters

    • v: Date

    Returns void

  • get valueChange(): ((s, e) => void)
  • Returns ((s, e) => void)

  • set valueChange(ev): void
  • Parameters

    • ev: ((s, e) => void)

    Returns void

  • get width(): string
  • Returns string

  • set width(value): void
  • Parameters

    • value: string

    Returns void

Methods

  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

  • Returns void

  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    Returns void

  • Returns void

  • Returns void

  • Returns a serialized copy of the exported visual model

    Returns string

  • Exports visual information about the current state of the grid.

    Returns any

  • Parameters

    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns any

  • Returns void

  • Returns DetailedReactHTMLElement<{
        children: any[];
        className: string;
        ref: ((ref) => void);
    }, any>

  • Type parameters

    Type Parameters

    • K extends never

    Parameters

    • state: {} | ((prevState, props) => {} | Pick<{}, K>) | Pick<{}, K>
    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Parameters

    • nextProps: any
    • nextState: any

    Returns boolean

  • Returns void