ig.scheduler.DayOfWeekRecurrenceRule

Rule that matches a specific weekday, or a relative day of the week within a month or year.

Remarks

DayOfWeekRecurrenceRule can be used to specify a day of week or a relative day of week within month or year. If the frequency is monthly or if a MonthOfYearRecurrenceRule is present then the DayOfWeekRecurrenceRule.relativePosition indentifies the relative position within a month. Otherwise if the frequency of the recurrence is yearly then it identifies the relative position within the year. In case of monthly, valid values are -5 to -1 and 1 to 5. In case of yearly, valid values are -53 to -1 and 1 to 53.

Dependencies

jquery-1.4.4.js
infragistics.util.js
infragistics.ext_core.js
infragistics.ext_collections.js
infragistics.ext_collectionsExtended.js
infragistics.ext_io.js
infragistics.ext_text.js
infragistics.ext_web.js
infragistics.dv_core.js
infragistics.dv_jquerydom.js
infragistics.dv_interactivity.js
infragistics.ext_ui.js
The current widget has no options.
The current widget has no events.
  • ig.scheduler.DayOfWeekRecurrenceRule
    Constructor

    new $.ig.scheduler.DayOfWeekRecurrenceRule( );

    Initializes a new instance of DayOfWeekRecurrenceRule object.

  • ig.scheduler.DayOfWeekRecurrenceRule
    Constructor

    new $.ig.scheduler.DayOfWeekRecurrenceRule( day:ig.DayOfWeek, [relativePosition:number] );

    Initializes a new instance of DayOfWeekRecurrenceRule object.

    • day
    • Type:ig.DayOfWeek
    • Identifies the week day.
    • relativePosition
    • Type:number
    • Optional
    • Optional value that specifies the relative position of the day within month or year. If the frequency is monthly or if a MonthOfYearRecurrenceRule is present then the relative position indentifies the relative position within a month. If frequency is yearly then it identifies the relative position within the year. In case of monthly, valid values are -5 to -1 and 1 to 5. In case of yearly, valid values are -53 to -1 and 1 to 53.
  • day

    .day( );

    Gets the week day.

  • day

    .day( value:ig.DayOfWeek );

    Sets the week day.

    • value
    • Type:ig.DayOfWeek
  • equals
    Inherited

    .equals( obj:object );
    Return Type:
    boolean
    Return Type Description:
    True if the object equals this object. False otherwise.

    Overridden. Returns true if the specified object equals this object.

    • obj
    • Type:object
    • Object to compare.
  • getHashCode
    Inherited

    .getHashCode( );
    Return Type:
    number
    Return Type Description:
    Integer hash code value.

    Overridden. Returns the hash code of this object.

  • raisePropertyChangedEvent
    Inherited

    .raisePropertyChangedEvent( propertyName:string );

    Raises the DateRecurrenceRuleBase.propertyChanged event.

    • propertyName
    • Type:string
    • The name of the property whose value has changed.
  • relativePosition

    .relativePosition( );

    Relative position of the occurrence of the week-day within a month or a year. Valid values are 1 to 5 and -5 to -1 for monthly frequency and 1 to 53 and -53 to -1 for yearly frequency.

    Remarks

    RelativePosition specifies the relative position of the occurrence of the week-day within a month or a year. Valid values are 1 to 5 and -5 to -1 for monthly rule and 1 to 53 and -53 to -1 for yearly rule. For example, if DayOfWeekRecurrenceRule.day is Monday and the RelativePosition is -1, then it specifies the last Monday in the month.
  • relativePosition

    .relativePosition( value:number );

    Relative position of the occurrence of the week-day within a month or a year. Valid values are 1 to 5 and -5 to -1 for monthly frequency and 1 to 53 and -53 to -1 for yearly frequency.

    • value
    • Type:number

    Remarks

    RelativePosition specifies the relative position of the occurrence of the week-day within a month or a year. Valid values are 1 to 5 and -5 to -1 for monthly rule and 1 to 53 and -53 to -1 for yearly rule. For example, if DayOfWeekRecurrenceRule.day is Monday and the RelativePosition is -1, then it specifies the last Monday in the month.

Copyright © 1996 - 2019 Infragistics, Inc. All rights reserved.