מדריך | מדריך - איך להכין תוסף לוורד בקלות

pcinfogmach

עקב בקשת הציבור לאחר פירסום תוסף זה מצו"ב מדריך איך ליצור תוסף לוורד.

פרק א' - הכנת התבנית

התבנית בנויה בעצם מכמה חלקים ומי שרוצה יכול לבנות אותה באופן ידני (עיין כאן).

טיפ: שנו את הסיומת של התבנית דלהלן ל-zip כדי לצפות בקבצים השונים שבתוכו. הקבצים שאנו מעוניינים בהם נמצאים רובם בתוך התיקייה customUI

תיאורטית ישנם תוכנות שבונים את התבנית בשבילך - למעשה הרבה פעמים זה לא עובד כל כך טוב.

לכן ההמלצה שלי היא פשוט להשתמש עם התבנית שהכנתי עבורכם.
תבנית עבור הכנת תוסף לוורד.zip
עריכה: הכנתי לכם תבנית חדשה שמתאימה גם לגירסאות חדשות יותר של וורד
תבנית חדשה.zip

פרק ב' - היכרות עם חלקי התבנית

בפרקים דלהלן אנו נתמקד בעיקר בשני חלקים של התבנית

יצירת הכפתורים - אותם נערוך על ידי התוכנה office-ribbonx-editor.
(אין חובה להשתמש בתוכנה, אפשר לערוך את הקבצים ישירות בתוך התיקייה customUI הנ"ל. בכל אופן במדריך זה נשתמש בתוכנה מאחר והיא מקילה מאוד על העבודה).
יצירת הקישורים בין התבנית לפקודות מאקרו - אותם נערוך בתוך עורך המאקרו של תוכנת וורד.

בואו נפתח שניה את התבנית על ידי תוכנת וורד. זוהי התמונה של הלשונית החדשה שיצרנו על התוסף שבתבנית.

קחו דקה להתבונן בלחצנים השונים שלפניכם. כפתור קטן, כפתור מפוצל קטן, כפתור גדול, כפתור מפוצל גדול. כמו"כ התוסף מחולק לשני קבוצות קבוצה א וקבוצה ב.

שמתם לב לתמונה של הלחצנים? התמונה שבקבוצה א אני יצרתי ואילו התמונה שבקבוצה ב שייכת לספרייה המובנית של תוכנת וורד. על כך נדבר בהמשך.

כעת לחצו לרגע על כמה מהלחצנים. אם תשימו לב הלחצנים שבקבוצה א עובדים ואילו הלחצנים שבקבוצה ב אינם עובדים.
הסיבה לכך היא משום שבקבוצה א כבר הוגדרו פקודות המאקרו המקשרים בין הלחצנים לפקודות ואילו בקבוצה ב רק יצרנו את הלחצנים מבלי להגדיר את הקישורים.

פרק ג' - יצירת הלחצנים - הקדמה

אם עוד לא הורדתם את התוכנה officeribbonxeditor הורידו אותה כעת:
התוכנה זמינה בגירסה ניידת, או בגירסה להתקנה במחשב.

כעת פתחו את התוכנה. ובצד שמאל למעלה לחצו על open כדי לפתוח את התבנית

כעת בתפריט בצד שמאל לחצו על costumUI14.XML כדי לפתוח את הקוד.

ספויילר

לפני שנסביר את הקודים זוכרים את הלחצנים שבתבנית?
"כפתור קטן", "כפתור מפוצל קטן", "כפתור גדול", "כפתור מפוצל גדול". ו"קבוצה א" ו"קבוצה ב". שמות הכפתורים הללו נמצאים בתוך התבנית בעברית - אם תתבלבלו תוכלו להשתמש עם שמות אלו כמורי דרך.

שימו לב שרוב הקודים חוזרים על עצמם כך שברגע שנתפוס את הרעיון כבר נוכל לנווט בתוך הקוד בקלות.

פרק ד' - הסבר קצר על חלקי הקוד

שימו לב שהקודים מחולקים לשלוש צבעים - כחול, סגול, ואדום.

צבע כחול משמש עבור אבני הבניין של הקוד:
tab = לשונית
group = קבוצה
button = כפתור רגיל
splitButton = כפתור משולב
menu = התפריט של הלחצן המשולב

אבני הבניין פותחים בסוגריים > ומסתיימים עם </
כך שכל מה שבתוך סוגריים אלו שייך לאבן בניין זו

אבני בניין שכוללים בתוכם עוד אבני בניין תמיד יהיו מוגדרים כקבוצה ובתחילתם תהיה הצהרה פותחת ובסופם הצהרה סוגרת,
(לדוגמא: הצהרה פותחת <splitButton id="smallsplitbutton1">
והצהרה סוגרת </splitButton>)

צבע סגול משמש לפקודות עבור אבני הבניין (פקודות תמיד באות עם = לאחריהם).
צבע אדום משמש עבור תוכן הפקודות ("תוכן הפקודות תמיד יהיה בתוך מירכאות")

אם תשימו לב ארבעת הפקודות דלהלן תמיד יופיעו בשורה כמו חיילים בכל לחצן.
=id = שם הלחצן, הלשונית או הקבוצה (חובה)
=label = הכיתוב שיופיע על הלחצן או הלשונית (לא חובה - לחצן קטן ללא כיתוב יופיע כריבוע קטן, לחצן קטן עם כיתוב יופיע כמלבן קטן).
=image = הסמל של הלחצן (לא חובה)
=onAction = מאקרו הקישור בו הלחצן ישתמש (חובה)
ועוד פקודה אחת
=size = מופיע רק כאשר נרצה להגדיר את הלחצן כ large כלומר גדול. (ברירת המחדל היא - לחצן קטן)

פרק ה' - הבר על הקודים השונים למעשה

אז בואו ננתח את הקודים השונים לעת עתה נתמקד בקודים של הלחצנים.
בתבנית הנ"ל יש לנו שני לחצנים שהם ארבע, כלומר: לחצן קטן, לחצן קטן משולב, לחצן גדול, לחצן גדול משולב.

זהו הקוד עבור לחצן קטן:

  <button
                 id="smallbutton1"
                 label="כפתור קטן"
                 image="image1"
                 onAction="RibbonControl.smallbutton1"/>

הקוד פותח עם הצהרת הלחצן
קורא ללחצן שם
קובע את הכיתוב שיופיע עליו
קובע את הסמל של הלחצן
קובע את מאקרו הקישור בו הלחצן ישתמש

זהו הקוד עבור לחצן גדול:

<button
                 id="largebutton1"
                 label="כפתור גדול"
                 image="image1"
                 onAction="RibbonControl.largebutton1"
                 size="large" />

הקודים כמעט זהים
כל ההבדל הוא שהלחצן הגדול מוגדר כגדול על ידי שורה זו size="large"

הקוד עבור לחצן משולב הינו קצת יותר מורכב מאחר שהוא כולל בתוכו כמה לחצנים
3. זהו הקוד עבור לחצן גדול משולב

 <splitButton id="largesplitbutton1" size="large">                    
                          <button
                           id="largesplitbutton1main" 
                           label="כפתור מפוצל גדול"
                           image="image1"
                           onAction="RibbonControl.largesplitbutton1" />
                                            
                    <menu id="largesplitbutton1menu">                       
                              <button
                               id="largesplitbutton1menuitem1"
                               label="פריט מספר 1"
                               image="image1"
                               onAction="RibbonControl.largesplitbutton1" />                                 
                              <button
                               id="largesplitbutton1menuitem2"
                               label="פריט מספר 2"
                               image="image1"
                               onAction="RibbonControl.largesplitbutton1" />                                 
                    </menu>
                </splitButton>

הקוד פותח בהגדרת לחצן משולב ומגדיר אותו כלחצן גדול
<splitButton id="largesplitbutton1" size="large">
כעת הקוד מגדיר את הלחצן הראשי - בעצם חלק זה של הקוד דומה לכל לחצן רגיל.
לאחמ"כ הקוד פותח את לחצני התפריט על ידי
<menu id="largesplitbutton1menu">
בתוך לחצני התפריט יש לנו 2 לחצנים - בעצם חלק זה של הקוד דומה לכל לחצן רגיל.
לאחמ"כ הקוד סוגר את קבוצת התפריט
</menu>
וסוגר את קבוצת הלחצן המשולב
</splitButton>

פרק ו' - הוספת לחצנים נוספים

ממש קל להוסיף לחצנים נוספים פשוט יש להעתיק ולהדביק את הקוד הרצוי.

שימו לב! הלחצנים יופיעו בסרגל הכלים לפי הסדר בו הם מופיעים בקוד.
כדי לשנות מיקום של לחצן מסוים יש לגזור את הקוד שלו ולהדביקו בסדר ובמיקום הרצוי.

כדי לפתוח קבוצה חדשה יש להשתמש בפקודות:
<group id="group1" label="קבוצה א"> בהתחלה
ו </group> בסוף

כדי להגדיר לשונית חדשה יש להשתמש בפקודות:
<tab id="CustomTab1" label="התוסף שלי"> בהתחלה
ו </tab> בסוף

לאחר שהדבקתם את הקוד החדש יש לשנות את הגדרות הלחצן (התוסף אינו יכול לסבול כפילויות בקוד).
יש לשנות את:
=id = שם הלחצן (או הלשונית)
=label = הכיתוב שיופיע על הלחצן (או הלשונית)
=onAction = מאקרו הקישור בו הלחצן ישתמש.
הערה חשובה: בפקודה זו של =onAction אין לגעת ב - RibbonControl., הגדרת שם מאקרו הקישור מופיע אחרי זה. לדוגמא: אם מופיע בקוד RibbonControl.largesplitbutton1 אז largesplitbutton1 הוא שם מאקרו הקישור ואותו יש לשנות.

בלחצן משולב יש לשנות ג"כ את שורת ה =id בהצהרת הלחצן המשולב ובהצהרת התפריט.
הערה: בלחצן משולב גדול ההגדרה של "size="large תהיה בהצהרה הראשונה של הלחצן המשולב, כך: <splitButton id="largesplitbutton1" size="large">

לאחר שגמרתם לשנות את הגדרות הלחצן מומלץ להריץ את פקודת validate בסרגל הכלים

פקודה זו בודקת את הקוד ומתריעה מפני שגיאות וכפילויות.

פרק ז' - עריכת סמלים

קוד זה מוסיף סמל ללחצן

imageMso="VisualBasic"

בתוך המירכאות יש להכניס את שם הסמל מתוך הספרייה המובנית של וורד. עיין כאן לספרייה המלאה. אני השתמשתי עם התמונה "VisualBasic".
מקורות נוספים עיין כאן או כאן

אם ברצונכם להשתמש עם סמל שאתם יצרתם תוכלו לעשות זאת כדלהלן:
קודם כל יש ליצור תמונה של הסמל בגודל המדוייק בו הוא הולך להופיע בסרגל הכלים (גדול קטן). תוכלו להשתמש לשם כך עם תוכנת הצייר של ווינדוס.
מומלץ לשמור את התמונה כקובץ png
מומלץ להסיר את הרקע (תוכלו להיעזר באתר זה)

לאחר שגמרתם לעצב את הסמל לחצו על Insert Icons בסרגל הכלים של תוכנת העריכה והוסיפו את הסמל שיצרתם.

כעת הזינו את הקוד הזה אצל הלחצן המתאים:

image="image1"

image1 הינו שם הסמל - יש לשנותו לשם הסמל שיצרתם.

פרק ח' - קישור הפקודות

זהו סיימנו עם עורך הלחצנים כעת אנו צריכים לקשר אותם לפקודות הרצויות.
סגרןואת עורך הלחצנים ופתחו את התבנית בתוך תוכנת וורד.
לחצו על קיצור המקשים Alt + F11 כדי לפתוח את עורך המאקרואים.

בתוך התבנית של התוסף תמצאו שלוש מודולים

install - מכיל בתוכו מאקרו להתקנת התוסף במחשב.

תוכלו להגדיר קיצור דרך עבור מאקרו זה כך:

macros - מכיל בתוכו את הפקודות אותם הלחצנים אמורים לפעול
כאן יש להוסיף את פקודות המאקרו שברצונכם לקשר אל המקשים

RibbonControl - מכיל בתוכו את הקישורים בין הפקודות ללחצנים
כל הפקודות בנויות על אותו עיקרון, ההבדל היחיד הוא בלחצן המשולב שהוא כולל בתוכו כמה מקשים.
הבסיס של כל הפקודות הוא

Sub smallbutton1(ByVal control As IRibbonControl)
Select Case control.id
  Case Is = "smallbutton1"
    Macros.macro1
End Select
End Sub

תוכלו להתאים קוד זה עבור כל לחצן
Sub הינו שם המאקרו אליו ייחסתם את הלחצן בתוך עורך הלחצנים.
Case Is = מתייחס לשם הלחצן
Macros.macro1 מתייחס לפקודה אותה אנו מקשרים ללחצן (Macros. הינו שם המודול בו נמצאת הפקודה macro1 הינו שם הפקודה).

ולסיום לא לשכוח לשמור את השינויים בתבנית.

זוכרים את קבוצה ב? הלחצנים שלה לא עבדו - בואו נקשר אותם לפקודות כעת:
קודם כל ניכנס אל המודול macros ונוסיף קודים עבור הלחצנים. לאחמ"כ נעתיק את כל פקודות הקישור שבמודול RibbonControl ונדביק אותם שוב בסוף המודול. כעת נשנה את כל המופעים של המספר 1 למספר 2 ובכן יצרנו קישורים עבור קבוצה ב)

בהצלחה!

נ.ב. כדי שהתוסף יעלה יחד עם התוכנה יש להוסיפו אל תיקיית %AppData%\Microsoft\Word\STARTUP
למעשה המאקרו של ההתקנה בתוך המודול install יכול לעשות זאת עבורכם אוטומטית.

pcinfogmach

קודים נוספים

קוד בשביל כפתור תיבת דו-שיח

 <group id="customGroup" label="Custom Group">
   <dialogBoxLauncher>
     <button id="button" screentip="Dialog Box Launcher" />
   </dialogBoxLauncher>
 </group>

הפקודה screentip פירושה התיבה שתופיע על ידי ריחוף הסמן מעל הכפתור בלי ללחוץ. (פקודה זו עובדת בכל כפתור שהוא אבל כאן היא נצרכת מאוד).

את שאר הקוד יש לעשות כמו כל כפתור.

אם תרצו לתכנת תיבת מידע עבור לחצן זה:
הקוד בשביל תיבת מידע במאקרו הוא msgbox "הטקסט שאתם רוצים להכניס " (יש רווח לכאורה מיותר כדי לחזוך בעיות אם בחרתם לכתוב שני משפטים נפרדים).
כדי לעשות מעבר שורה ידני הקוד הוא & vbnewline &

כפתור לאחד מהפקודות הרגילות של אופיס (כגון הדבק לדוגמא, או פתיחת חלון הסגנונות)

<button idMso="Cut" />\

"cut" זהו הקוד בשביל הכפתור "גזור", יש להחליף לפי השם שמופיע על הכפתור על ידי ריחוף מעליו עם סמן העכבר. (אפשר בתפריט של הוספת פריטים לרצועת הכלים לראות את השם באנגלית ע"י ריחוף.)
יש הרבה כפתורים שהקוד בהם הוא קצת שונה

<control idMso="BreaksGallery"/>

הערה: יש להשתמש עם אותיות רישיות כמו שהם מופיעים במקור אחרת זה לא יעבוד

עיצוב הכיתוב שעל הכפתור

label="Button"
description="This is a verbose description that describes
     the function of this control in detail."

פקודת label מגדירה את הכותרת ופקודת description מגדירה את הכיתוב.

עיצוב התיבה שמופיעה על ידי ריחוף

screentip="כותרת" 
 supertip= "מלל מלל מלל מלל"

מאוד חשוב להוסיף את המלל במקום הנכון כי אחרת כל המלל יהיה בשורה אחת ארוכה.

מעבר שורה ידני בטקסט

מקורות נוספים:

קודים נוספים תוכלו לראות בתוך התוכנה עצמה על ידי פתיחת התבנית בתוכנה ולחיצה על insert

הדוגמא האחרונה למשל משמשת עבור הכנסת כפתור\ים בתוך לשונית שהיא כבר קיימת.

קוד מעניין עבור יצירת תפריט רשימה תוכלו לראות בגירסה מס' 2 של התוסף החדש לוורד כאן מקור הקוד הוא מכאן שם תוכלו למצוא קודים נוספים- מצו"ב התבניות מהמקור הנ"ל. customize_ribbon_main_examples.zip

עדכון:
מצאתי תבנית שעובדת בשיטה קצת שונה כאן. לינק ישיר להורדת התבנית לחץ כאן.
באתר זה קיים גם קורס מלא בנושא (באנגלית) + תבנית מלאה עם כל סוגי הלחצנים - בתשלום למי שמעוניין בכך כאן.

תבנית נוספת מצאתי כאן ויש שם גם כתבות מלאות על הנושא

קודים נוספים תוכלו למצוא במדריך הרישמי של מיקרוסופט
וכן דוגמאות נוספות תוכלו לראות פה

ועוד שני כתבות שימושיות
https://www.contextures.com/excelribbonmacrostab.html
https://www.contextures.com/excelribbonaddcustomtab.html

מסמך להורדה למחשב
https://interoperability.blob.core.windows.net/files/MS-CUSTOMUI/[MS-CUSTOMUI].pdf?&~nfopt(fileDistorted=22159770024873704)

menajemmendel

פוסט זה נמחק!

menajemmendel

@pcinfogmach תודה רבה על המדריך המושקע, עשית עבודה מאד יפה ותועלתית
שאלה קטנה, אם רוצים להוסיף כפתור לאחד מהפקודות הרגילות של אופיס (כגון הדבק לדוגמא, או פתיחת חלון הסגנונות) האם יש אפשרות, ואם כן איך,
כי ראיתי שדרך ה''התאמה אישית של רצועת הכלים'' לא ניתן להוסיף פריטים לרצועה החדשה שיצרת לנו

pcinfogmach

@menajemmendel
אם רוצים להכניס כפתור לאחד מהפקודות הרגילות של אופיס יש לכתוב מאקרו שמפעיל פקודה זו ולשייך אליו את הכפתור החדש.

דוגמא לכך תוכל לראות בתבנית זו (תבנית מס' שלוש בקובץ) שהבאתי תחת מקורות נוספים יש שם פקודה שפותחת את עורך המאקרו של וורד תראה איך הוא עשה את זה ותעתיק משם לכל פקודה אחרת שתרצה.
בהצלחה.

menajemmendel

@pcinfogmach
כן ככה ידעתי שאפשר לעשות, אבל חשבתי אם יש אופן ישיר שהעורך יקרה לפעולה עצמה ולא לעשות מאקרוים מיותרים

אגב יש לי רעיון שאולי יכול להקל קצת יותר את העבודה:
אז קודם תודה רבה על המדריך המושקע, עזר לי להבין איך זה עובד, אבל עדיין היה לי קצת מסובך, כי היה נראה לי מדאי הרבה פרטים (שלא כולם ידעתי למה צריך אותם) אז שיניתי אותו קצת שיהיה לי יותר ברור וקל לשימוש, ונראה לי שכן יהיה גם לרוב המשתמשים (במיוחד אלו שלא רגילים לתכנות)
א. בעורך אפשר לכתוב כל הפרטים ששייכים לאותו כפתור באותו שורה,

ב. בVBA ראיתי שאפשר למחוק את השורות שקשורות לCASE דהיינו במקום
במקום

Sub smallbutton1(ByVal control As IRibbonControl)
Select Case control.id
  Case Is = "smallbutton1"
    Macros.macro1
End Select
End Sub

אפשר לכתבו רק

Sub smallbutton1(ByVal control As IRibbonControl)
    Macros.macro1
End Sub

בינתיים לא ראיתי שום בעיה בילעדיהם, אבל אולי אני טועה

ג. מה שכתבת וכן הOPTION EXPLICIT ו ''לא לגעת'' אכן ברוב חוצפתי נגעתי ומחקתי אותו ועובד כרגיל

Option Explicit
Public myRibbon As IRibbonUI
Sub Onload(ribbon As IRibbonUI)
'המאקרו הזה יוצר את סרגל הכלים - לא לגעת
Set myRibbon = ribbon
End Sub

תודה רבה

pcinfogmach

@menajemmendel תודה רבה על ההערות המחכימות רק נוסיף כמה הבהרות

@menajemmendel כתב במדריך | מדריך - איך להכין תוסף לוורד בקלות:

בעורך אפשר לכתוב כל הפרטים ששייכים לאותו כפתור באותו שורה,

אכן כן ומי שיותר טוב לו ומובן לו כך שיכתוב כך, נראה לי שבגדול זה תלוי בסוג ראש.
הסיבה שכתבתי אחד מעל השני היה לצורך המדריך כדי שיוכלו לראות בעיניים עד כמה זה פשוט לערוך כפתור - כי בעצם כל הכפתורים בנויים באותה צורה כולל הכפתורים המשולבים.

@menajemmendel כתב במדריך | מדריך - איך להכין תוסף לוורד בקלות:

ב. בVBA ראיתי שאפשר למחוק את השורות שקשורות לCASE דהיינו במקום

בעיקרון כן
המקרה של ה-case נמצא שם כדי שאם ירצו להוסיף עוד פקודות בכפתור יוכלו לעשות זאת בקלות על ידי הוספת case נוסף, וכמו שיש בכפתורים המשולבים שהראיתי בתבנית.

@menajemmendel כתב במדריך | מדריך - איך להכין תוסף לוורד בקלות:

מה שכתבת וכן הOPTION EXPLICIT ו ''לא לגעת'' אכן ברוב חוצפתי נגעתי ומחקתי אותו ועובד כרגיל

ייתכן שזה יעבוד אבל אם אני זוכר טוב זה תלוי בגירסה של וורד. איך שלא יהיה לעניות דעתי עדיף לא לגעת במה שלא מבינים. כי ייתכן שיש עוד סיבות שלא ידועות לנו - בסוף היום השורות האלה אינם שלי אלא כך קראתי בהדרכות שונות שצריך לעשות.

pcinfogmach

@menajemmendel כתב במדריך | מדריך - איך להכין תוסף לוורד בקלות:

@pcinfogmach תודה רבה על המדריך המושקע, עשית עבודה מאד יפה ותועלתית
שאלה קטנה, אם רוצים להוסיף כפתור לאחד מהפקודות הרגילות של אופיס (כגון הדבק לדוגמא, או פתיחת חלון הסגנונות) האם יש אפשרות, ואם כן איך,
כי ראיתי שדרך ה''התאמה אישית של רצועת הכלים'' לא ניתן להוסיף פריטים לרצועה החדשה שיצרת לנו

הנה:

<button idMso="Cut" />\

"cut" זהו הקוד בשביל הכפתור "גזור", יש להחליף לפי השם שמופיע על הכפתור על ידי ריחוף מעליו עם סמן העכבר.

יש הרבה כפתורים שהקוד בהם הוא קצת שונה

<control idMso="BreaksGallery"/>

menajemmendel

@pcinfogmach כתב במדריך | מדריך - איך להכין תוסף לוורד בקלות:

cut" זהו הקוד בשביל הכפתור "גזור", יש להחליף לפי השם שמופיע על הכפתור על ידי ריחוף מעליו עם סמן העכבר

אבל אז לא מופיע באנגלית, איך נדע את המילה המדוייקת, כנראה שיש איזהו רשימית של אופיס, בלי נדר אנסה לחפש
ותודב רבה

מאקרו

@menajemmendel אפשר בתפריט של הוספת פריטים לרצועת הכלים לראות את השם באנגלית ע"י ריחוף.

menajemmendel

@מאקרו תודה

pcinfogmach

@menajemmendel
לגבי הקוד עבור כפתורים מובנים עכשיו ראיתי ש יש הרבה כפתורים שהקוד בהם הוא קצת שונה

<control idMso="BreaksGallery"/>

menajemmendel

@pcinfogmach ואיך יודעים מתי buton ומתי control?

pcinfogmach

@menajemmendel
על פי רוב זה control אם זה לא עובד תנסה את button
רצלי וורד נותן התראת שגיאה אם השתמשתי בפקודה הלא נכונה כשאני פותח את התבנית

pcinfogmach

@pcinfogmach
עריכה: הכנתי לכם תבנית חדשה שמתאימה גם לגירסאות חדשות יותר של וורד
עריכה2: עכשיו התבנית גם מכיל בתוכו את המדריך
תבנית חדשה.zip