Interface FramedControl

Interface for a framed control, which is either a Web Resource or an Iframe.

See

Control

Remarks

An Iframe control provides additional methods, so use IframeControl where appropriate. Silverlight controls should use SilverlightControl.

Hierarchy

Methods

getContentWindow getControlType getLabel getName getObject getParent getSrc getVisible setLabel setSrc

Methods

getContentWindow

  • Returns the content window that represents an IFRAME or web resource.

    Returns Promise<Window>

    A promise that contains a content window instance representing an IFRAME or web resource.

    Remarks

    This method is supported only on Unified Interface. The implementer is expected to call a custom function within the returned window that will receive the Xrm and formContext objects as parameters.

getControlType

  • Gets the controls type.

    Returns string

    The control type.

    Values returned are:

    • standard
    • iframe
    • lookup
    • optionset
    • subgrid
    • webresource
    • notes
    • timercontrol
    • kbsearch
    • quickform (see ui.QuickForm)
    • customcontrol: . (A custom control for mobile phone and tablet clients).
    • customsubgrid: . (A custom dataset control for mobile phone and tablet clients).

getLabel

  • Gets the label.

    Returns string

    The label.

getName

  • Gets the name of the control on the form.

    Returns string

    The name of the control.

    Remarks

    The name assigned to a control is not determined until the form loads. Changes to the form may change the name assigned to a given control. When you use the control getName method the name of the first control will be the same as the name of the attribute. The second instance of a control for that attribute will be "1". The pattern +N will continue for each additional control added to the form for a specific attribute. When a form displays a business process flow control in the header, additional controls will be added for each attribute that is displayed in the business process flow. These controls have a unique name like the following: header_process_.

getObject

  • Gets the DOM element containing the control.

    Returns HTMLIFrameElement

    The container object.

    Remarks

    Unavailable for Microsoft Dynamics CRM for tablets.

getParent

getSrc

  • Gets the URL value of the control.

    Returns string

    The source URL.

    Remarks

    Unavailable for Microsoft Dynamics CRM for tablets.

getVisible

  • Gets the visibility state.

    Returns boolean

    true if the tab is visible, otherwise false.

setLabel

  • Sets the label.

    Parameters

    • label: string

      The label.

    Returns void

setSrc

  • Sets the URL value of the control.

    Parameters

    • src: string

      The source URL.

    Returns void

    Remarks

    Unavailable for Microsoft Dynamics CRM for tablets.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc