Skip to content

utils

Utility functions to support forms module.

Functions

bitmap_from_file(bitmap_file)

Create BitmapImage from a bitmap file.

Parameters:

Name Type Description Default
bitmap_file str

path to bitmap file

 required

Returns:

Type Description
BitmapImage

bitmap image object
Source code in pyrevitlib/pyrevit/forms/utils.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
def bitmap_from_file(bitmap_file):
    """Create BitmapImage from a bitmap file.

    Args:
        bitmap_file (str): path to bitmap file

    Returns:
        (BitmapImage): bitmap image object
    """
    bitmap = Imaging.BitmapImage()
    bitmap.BeginInit()
    bitmap.UriSource = framework.Uri(bitmap_file)
    bitmap.CacheOption = Imaging.BitmapCacheOption.OnLoad
    bitmap.CreateOptions = Imaging.BitmapCreateOptions.IgnoreImageCache
    bitmap.EndInit()
    bitmap.Freeze()
    return bitmap

load_component(xaml_file, comp_type)

Load WPF component from xaml file.

Parameters:

Name Type Description Default
xaml_file str

xaml file path

 required
comp_type Controls

WPF control type

 required

Returns:

Type Description
Controls

loaded WPF control
Source code in pyrevitlib/pyrevit/forms/utils.py 
26
27
28
29
30
31
32
33
34
35
36
def load_component(xaml_file, comp_type):
    """Load WPF component from xaml file.

    Args:
        xaml_file (str): xaml file path
        comp_type (System.Windows.Controls): WPF control type

    Returns:
        (System.Windows.Controls): loaded WPF control
    """
    return wpf.LoadComponent(comp_type, xaml_file)

load_ctrl_template(xaml_file)

Load System.Windows.Controls.ControlTemplate from xaml file.

Parameters:

Name Type Description Default
xaml_file str

xaml file path

 required

Returns:

Type Description
ControlTemplate

loaded control template
Source code in pyrevitlib/pyrevit/forms/utils.py 
39
40
41
42
43
44
45
46
47
48
def load_ctrl_template(xaml_file):
    """Load System.Windows.Controls.ControlTemplate from xaml file.

    Args:
        xaml_file (str): xaml file path

    Returns:
        (System.Windows.Controls.ControlTemplate): loaded control template
    """
    return load_component(xaml_file, Controls.ControlTemplate())

load_itemspanel_template(xaml_file)

Load System.Windows.Controls.ItemsPanelTemplate from xaml file.

Parameters:

Name Type Description Default
xaml_file str

xaml file path

 required

Returns:

Type Description
ControlTemplate

loaded items-panel template
Source code in pyrevitlib/pyrevit/forms/utils.py 
51
52
53
54
55
56
57
58
59
60
def load_itemspanel_template(xaml_file):
    """Load System.Windows.Controls.ItemsPanelTemplate from xaml file.

    Args:
        xaml_file (str): xaml file path

    Returns:
        (System.Windows.Controls.ControlTemplate): loaded items-panel template
    """
    return load_component(xaml_file, Controls.ItemsPanelTemplate())