diff --git a/pyrevitlib/pyrevit/forms/__init__.py b/pyrevitlib/pyrevit/forms/__init__.py index fc43700d3..288c9730f 100644 --- a/pyrevitlib/pyrevit/forms/__init__.py +++ b/pyrevitlib/pyrevit/forms/__init__.py @@ -1,7 +1,7 @@ """Reusable WPF forms for pyRevit. Examples: - ``` + ```py from pyrevit.forms import WPFWindow ``` """ @@ -151,7 +151,7 @@ class WPFWindow(framework.Windows.Window): set_owner (bool): set the owner of window to host app window Examples: - ``` + ```py from pyrevit import forms layout = ', @@ -2132,7 +2132,7 @@ def select_sheets(title='Select Sheets', (list[DB.ViewSheet]): list of selected sheets Examples: - ``` + ```py from pyrevit import forms forms.select_sheets() [, @@ -2229,7 +2229,7 @@ def select_views(title='Select Views', (list[DB.View]): list of selected views Examples: - ``` + ```py from pyrevit import forms forms.select_views() [, @@ -2299,7 +2299,7 @@ def select_levels(title='Select Levels', (list[DB.Level]): list of selected levels Examples: - ``` + ```py from pyrevit import forms forms.select_levels() [, @@ -2369,7 +2369,7 @@ def select_viewtemplates(title='Select View Templates', (list[DB.View]): list of selected view templates Examples: - ``` + ```py from pyrevit import forms forms.select_viewtemplates() [, @@ -2418,7 +2418,7 @@ def select_schedules(title='Select Schedules', (list[DB.ViewSchedule]): list of selected schedules Examples: - ``` + ```py from pyrevit import forms forms.select_schedules() [, @@ -2467,7 +2467,7 @@ def select_open_docs(title='Select Open Documents', (list[DB.Document]): list of selected documents Examples: - ``` + ```py from pyrevit import forms forms.select_open_docs() [, @@ -2520,7 +2520,7 @@ def select_titleblocks(title='Select Titleblock', (DB.ElementId): selected titleblock id. Examples: - ``` + ```py from pyrevit import forms forms.select_titleblocks() @@ -2560,7 +2560,7 @@ def select_swatch(title='Select Color Swatch', button_name='Select'): (pyrevit.coreutils.colors.RGB): rgb color Examples: - ``` + ```py from pyrevit import forms forms.select_swatch(title="Select Text Color") @@ -2594,7 +2594,7 @@ def select_image(images, title='Select Image', button_name='Select'): (str): path of the selected image Examples: - ``` + ```py from pyrevit import forms forms.select_image(['C:/path/to/image1.png', 'C:/path/to/image2.png'], @@ -2658,7 +2658,7 @@ def select_parameters(src_element, (list[ParamDef]): list of paramdef objects Examples: - ``` + ```py forms.select_parameter( src_element, title='Select Parameters', @@ -2745,7 +2745,7 @@ def select_family_parameters(family_doc, (list[DB.FamilyParameter]): list of family parameter objects Examples: - ``` + ```py forms.select_family_parameters( family_doc, title='Select Parameters', @@ -2829,7 +2829,7 @@ def alert(msg, title=None, sub_msg=None, expanded=None, footer='', (bool): True if okay, yes, or retry, otherwise False Examples: - ``` + ```py from pyrevit import forms forms.alert('Are you sure?', sub_msg='Click here if you are not sure and want to go to the pyRevit Forum', @@ -2944,7 +2944,7 @@ def alert_ifnot(condition, msg, *args, **kwargs): (bool): True if okay, yes, or retry, otherwise False Examples: - ``` + ```py from pyrevit import forms forms.alert_ifnot(value > 12, 'Are you sure?', @@ -3008,7 +3008,7 @@ def show_balloon(header, text, tooltip='', group='', is_favourite=False, is_new= click_result (def): Executed after a click event Examples: - ``` + ```py from pyrevit import forms date = '2019-01-01 00:00:00' date = datetime.datetime.strptime(date, '%Y-%m-%d %H:%M:%S') @@ -3047,18 +3047,18 @@ def pick_file(file_ext='*', files_filter='', init_dir='', (str | list[str]): file path or list of file paths if multi_file=True Examples: - ``` + ```py from pyrevit import forms forms.pick_file(file_ext='csv') r'C:\output\somefile.csv' ``` - ``` + ```py forms.pick_file(file_ext='csv', multi_file=True) [r'C:\output\somefile1.csv', r'C:\output\somefile2.csv'] ``` - ``` + ```py forms.pick_file(files_filter='All Files (*.*)|*.*|' 'Excel Workbook (*.xlsx)|*.xlsx|' 'Excel 97-2003 Workbook|*.xls', @@ -3106,7 +3106,7 @@ def save_file(file_ext='', files_filter='', init_dir='', default_name='', (str): file path Examples: - ``` + ```py from pyrevit import forms forms.save_file(file_ext='csv') r'C:\output\somefile.csv' @@ -3207,7 +3207,7 @@ def check_familydoc(doc=None, family_cat=None, exitscript=False): (bool): True if doc is a Family and of provided category Examples: - ``` + ```py from pyrevit import forms forms.check_familydoc(doc=revit.doc, family_cat='Data Devices') True @@ -3239,7 +3239,7 @@ def check_modeldoc(doc=None, exitscript=False): (bool): True if doc is a Model Examples: - ``` + ```py from pyrevit import forms forms.check_modeldoc(doc=revit.doc) True @@ -3265,9 +3265,9 @@ def check_modelview(view, exitscript=False): (bool): True if view is model view Examples: - ``` + ```py from pyrevit import forms - ```forms.check_modelview(view=revit.active_view) + forms.check_modelview(view=revit.active_view) True ``` """ @@ -3289,7 +3289,7 @@ def check_viewtype(view, view_type, exitscript=False): (bool): True if view is of given type Examples: - ``` + ```py from pyrevit import forms forms.check_viewtype(revit.active_view, DB.ViewType.DrawingSheet) True @@ -3316,7 +3316,7 @@ def check_graphicalview(view, exitscript=False): (bool): True if view is a graphical view Examples: - ``` + ```py from pyrevit import forms forms.check_graphicalview(revit.active_view) True @@ -3344,7 +3344,7 @@ def toast(message, title='pyRevit', appid='pyRevit', actions (dict): dictionary of button names and action strings Examples: - ``` + ```py script.toast("Hello World!", title="My Script", appid="MyAPP", @@ -3380,7 +3380,7 @@ def ask_for_string(default=None, prompt=None, title=None, **kwargs): (str): selected string value Examples: - ``` + ```py forms.ask_for_string( default='some-tag', prompt='Enter new tag name:', @@ -3416,7 +3416,7 @@ def ask_for_unique_string(reserved_values, (str): selected unique string Examples: - ``` + ```py forms.ask_for_unique_string( prompt='Enter a Unique Name', title=self.Title, @@ -3457,7 +3457,7 @@ def ask_for_one_item(items, default=None, prompt=None, title=None, **kwargs): (str): selected item Examples: - ``` + ```py forms.ask_for_one_item( ['test item 1', 'test item 2', 'test item 3'], default='test item 2', @@ -3493,7 +3493,7 @@ def ask_for_date(default=None, prompt=None, title=None, **kwargs): (datetime.datetime): selected date Examples: - ``` + ```py forms.ask_for_date(default="", title="Enter deadline:") datetime.datetime(2019, 5, 17, 0, 0) ``` @@ -3528,7 +3528,7 @@ def ask_for_number_slider(default=None, min=0, max=100, interval=1, prompt=None, (str): selected string value Examples: - ``` + ```py forms.ask_for_number_slider( default=50, min = 0, @@ -3590,7 +3590,7 @@ def ask_for_color(default=None): (str): selected color in HEX ARGB e.g. #ff808080, or None if cancelled Examples: - ``` + ```py forms.ask_for_color() '#ff808080' ``` @@ -3616,7 +3616,7 @@ def inform_wip(): """Show work-in-progress prompt to user and exit script. Examples: - ``` + ```py forms.inform_wip() ``` """