Struct sap_scripting::types::GuiFrameWindow

pub struct GuiFrameWindow { /* private fields */ }

A GuiFrameWindow is a high level visual object in the runtime hierarchy. It can be either the main window or a modal popup window. See the GuiMainWindow and GuiModalWindow sections for examples. GuiFrameWindow itself is an abstract interface. GuiFrameWindow extends the GuiVContainer Object. The type prefix is wnd, the name is wnd plus the window number in square brackets.

Implementations

impl GuiFrameWindow

pub fn close(&self) -> Result<()>

The function attempts to close the window. Trying to close the last main window of a session will not succeed immediately; the dialog ‘Do you really want to log off?’ will be displayed first.

pub fn maximize(&self) -> Result<()>

This will maximize a window. It is not possible to maximize a modal window; it is always the main window which will be maximized.

Examples found in repository

examples/simple.rs (line 43)

fn main() -> Result<()> {
    // Initialise the environment.
    let com_instance = SAPComInstance::new()?;
    eprintln!("Got COM instance");
    let wrapper = com_instance.sap_wrapper()?;
    eprintln!("Got wrapper");
    let engine = wrapper.scripting_engine()?;
    eprintln!("Got scripting engine");
    let connection = engine.get_connection(0)?;
    eprintln!("Got connection");
    let session = connection.children(0)?;
    eprintln!("Got session");
    if let SAPComponent::GuiMainWindow(wnd) = session.find_by_id("wnd[0]")? {
        wnd.maximize().unwrap();

        if let SAPComponent::GuiOkCodeField(tbox_comp) =
            session.find_by_id("wnd[0]/tbar[0]/okcd")?
        {
            tbox_comp.set_text("/nfpl9").unwrap();
            wnd.send_vkey(0).unwrap();
        } else {
            panic!("no ok code field!");
        }
    } else {
        panic!("no window!");
    }

    Ok(())
}

pub fn send_vkey(&self, vkey: i32) -> Result<()>

The virtual key VKey is executed on the window. The VKeys are defined in the menu painter.

Examples found in repository

examples/simple.rs (line 49)

fn main() -> Result<()> {
    // Initialise the environment.
    let com_instance = SAPComInstance::new()?;
    eprintln!("Got COM instance");
    let wrapper = com_instance.sap_wrapper()?;
    eprintln!("Got wrapper");
    let engine = wrapper.scripting_engine()?;
    eprintln!("Got scripting engine");
    let connection = engine.get_connection(0)?;
    eprintln!("Got connection");
    let session = connection.children(0)?;
    eprintln!("Got session");
    if let SAPComponent::GuiMainWindow(wnd) = session.find_by_id("wnd[0]")? {
        wnd.maximize().unwrap();

        if let SAPComponent::GuiOkCodeField(tbox_comp) =
            session.find_by_id("wnd[0]/tbar[0]/okcd")?
        {
            tbox_comp.set_text("/nfpl9").unwrap();
            wnd.send_vkey(0).unwrap();
        } else {
            panic!("no ok code field!");
        }
    } else {
        panic!("no window!");
    }

    Ok(())
}

Trait Implementations

impl GuiComponentMethods<GuiFrameWindow> for GuiFrameWindow

fn container_type(&self) -> Result<bool>

This property is TRUE, if the object is a container and therefore has the Children property.

fn id(&self) -> Result<String>

An object id is a unique textual identifier for the object. It is built in a URLlike formatting, starting at the GuiApplication object and drilling down to the respective object.

fn name(&self) -> Result<String>

The name property is especially useful when working with simple scripts that only access dynpro fields. In that case a field can be found using its name and type information, which is easier to read than a possibly very long id. However, there is no guarantee that there are no two objects with the same name and type in a given dynpro.

fn kind(&self) -> Result<String>

The type information of GuiComponent can be used to determine which properties and methods an object supports. The value of the type string is the name of the type taken from this documentation.

fn kind_as_number(&self) -> Result<i64>

While the Type property is a string value, the TypeAsNumber property is a long value that can alternatively be used to identify an object’s type . It was added for better performance in methods such as FindByIdEx. Possible values for this property are taken from the GuiComponentTypeenumeration.

impl GuiContainerMethods<GuiFrameWindow> for GuiFrameWindow

fn find_by_id<S>(&self, id: S) -> Result<SAPComponent>where S: AsRef<str>,

Search through the object’s descendants for a given id. If the parameter is a fully qualified id, the function will first check if the container object’s id is a prefix of the id parameter. If that is the case, this prefix is truncated. If no descendant with the given id can be found the function raises an exception.

fn children(&self, n: u32) -> Result<GuiSession>

This collection contains all direct children of the object.

impl GuiVComponentMethods<GuiFrameWindow> for GuiFrameWindow

fn set_focus(&self) -> Result<()>

This function can be used to set the focus onto an object. If a user interacts with SAP GUI, it moves the focus whenever the interaction is with a new object. Interacting with an object through the scripting component does not change the focus. There are some cases in which the SAP application explicitly checks for the focus and behaves differently depending on the focused object.

fn visualize(&self, on: bool) -> Result<()>

Calling this method of a component will display a red frame around the specified component if the parameter on is true. The frame will be removed if on is false. Some components such as GuiCtrlGridView support displaying the frame around inner objects, such as cells. The format of the innerObject string is the same as for the dumpState method.

fn acc_text(&self) -> Result<String>

An additional text for accessibility support.

fn acc_text_on_request(&self) -> Result<String>

An additional text for accessibility support.

fn acc_tooltip(&self) -> Result<String>

An additional tooltip text for accessibility support.

fn changeable(&self) -> Result<bool>

An object is changeable if it is neither disabled nor read-only.

fn default_tooltip(&self) -> Result<String>

Tooltip text generated from the short text defined in the data dictionary for the given screen element type.

fn height(&self) -> Result<i64>

Height of the component in pixels.

fn icon_name(&self) -> Result<String>

If the object has been assigned an icon, then this property is the name of the icon, otherwise it is an empty string.

fn is_symbol_font(&self) -> Result<bool>

The property is TRUE if the component’s text is visualized in the SAP symbol font.

fn left(&self) -> Result<i64>

Left position of the element in screen coordinates

fn modified(&self) -> Result<bool>

An object is modified if its state has been changed by the user and this change has not yet been sent to the SAP system.

fn parent_frame(&self) -> Result<GuiComponent>

If the control is hosted by the Frame object, the value of the property is this frame. Overwise NULL.

fn screen_left(&self) -> Result<i64>

The y position of the component in screen coordinates.

fn screen_top(&self) -> Result<i64>

The x position of the component in screen coordinates.

fn text(&self) -> Result<String>

The value of this property very much depends on the type of the object on which it is called. This is obvious for text fields or menu items. On the other hand this property is empty for toolbar buttons and is the class id for shells. You can read the text property of a label, but you can’t change it, whereas you can only set the text property of a password field, but not read it.

fn set_text<S>(&self, value: S) -> Result<()>where S: AsRef<str>,

The value of this property very much depends on the type of the object on which it is called. This is obvious for text fields or menu items. On the other hand this property is empty for toolbar buttons and is the class id for shells. You can read the text property of a label, but you can’t change it, whereas you can only set the text property of a password field, but not read it.

fn tooltip(&self) -> Result<String>

The tooltip contains a text which is designed to help a user understand the meaning of a given text field or button.

fn top(&self) -> Result<i64>

Top coordinate of the element in screen coordinates.

fn width(&self) -> Result<i64>

Width of the component in pixels.

impl GuiVContainerMethods<GuiFrameWindow> for GuiFrameWindow

fn find_by_name<S>(&self, name: S, kind: S) -> Result<SAPComponent>where S: AsRef<str>,

Unlike FindById, this function does not guarantee a unique result. It will simply return the first descendant matching both the name and type parameters. This is a more natural description of the object than the complex id, but it only makes sense on dynpro objects as most other objects do not have a meaningful name. If no descendant with matching name and type can be found, the function raises an exception.

fn find_by_name_ex<S>(&self, name: S, kind: i64) -> Result<SAPComponent>where S: AsRef<str>,

This method works exactly like FindByName, but takes the type parameter with data type long coming from the GuiComponentType enumeration. See also GuiComponentType.

impl HasDispatch<GuiFrameWindow> for GuiFrameWindow

fn get_idispatch(&self) -> &IDispatch

Get the IDispatch object for low-level access to this component.