►
From YouTube: Excel shortcut customization APIs
Description
In this 13-minute Developer-focused demo, Abid Rahman shows how to use keyboard shortcuts to invoke actions in your add-ins with these 3 new APIs in KeyboardShortcuts 1.1 in Public Preview, that will assist with keyboard shortcuts management! Assign custom keyboard shortcuts per user, per platform. The shortcuts reviewed in this demo are replaceShortcuts, getShortcuts, and areShortcutsInUse. Quickly view and enable shortcuts for a specific user to avoid shortcut combinations already in use. This PnP Community demo is taken from the Office Add-ins community call – January 2022, recorded on January 12, 2022.
Demo Presenter: Abid Rahman, Program Manager (Microsoft)
Supporting documents:
• Sample Repo - Use keyboard shortcuts for Office add-in actions | https://github.com/OfficeDev/Office-Add-in-samples/tree/main/Samples/excel-keyboard-shortcuts
• Documentation - Add custom keyboard shortcuts to your Office Add-ins | https://docs.microsoft.com/office/dev/add-ins/design/keyboard-shortcuts
• Documentation - Keyboard Shortcuts 1.1 requirement sets | https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/keyboard-shortcuts-requirement-sets
• Documentation - Avoid key combinations in use by other add-ins | https://docs.microsoft.com/office/dev/add-ins/design/keyboard-shortcuts#avoid-key-combinations-in-use-by-other-add-ins
• Documentation - Enable custom keyboard shortcuts for specific users (preview) | https://docs.microsoft.com/office/dev/add-ins/design/keyboard-shortcuts#enable-custom-keyboard-shortcuts-for-specific-users-preview
• Feedback Repo – Issues – OfficeDev/Office-js | https://github.com/OfficeDev/office-js/issues
Stay connected:
• Learn more about the Microsoft 365 Patterns and Practices community at: http://aka.ms/m365pnp
• Visit the Microsoft 365 Patterns and Practices community YouTube channel: https://aka.ms/m365pnp/videos
A
Hello:
everyone,
my
name
is
abeed,
I'm
here
to
talk
about
some
of
the
new
shortcut
apis
that
we
have.
That
is
available
now
for
public
preview.
So
before
I
get
started
here,
I'm
going
to
do
a
quick
summary
of
what
shortcuts
are
so,
hopefully,
you've
been
able
to
use
shortcuts
over
the
last
couple
months,
but
essentially
keyboard
shortcuts
are
a
way
to
assign
shortcut
combinations
to
any
add-in
actions
that
you
have.
A
So
things
like
opening
and
closing
the
task,
pane
fetching
data
for
the
current
cell,
applying
any
kind
of
formatting
to
a
cell
or
opening
a
dialogue
or
resetting
settings
or
anything
within
within
the
runtime
of
your
add-in.
So
this
the
capability
has
been
out
now
for
for
about
six
months.
If
you
have
any
questions
about
keyboard
shortcuts
or
you
haven't
been
able
to
try
them
out,
please
do
go
ahead
and
click
on
the
links
on
this
slide.
A
We
have
a
sample
up
a
short
pnp
that
shows
you
how
how
keyboard
shortcuts
work
and
as
well
as
our
documentation
or
keyboard
shortcuts,
but
the
the
main
reason
I'm
here
today
is
to
talk
about
some
of
our
customization
apis
that
we
are
now
introducing
for
public
preview.
So
there
are
three
new
apis
that
are
coming
out
and
all
of
these
are
going
to
be
part
of
the
new
keyboard
shortcuts
1.1
requirement
set.
A
So
if
you
have
any
questions
about
hey
what
versions
of
excel
can
I
can,
I
use
this
requirement
set
for
go
ahead
and
click
that
click
that
requirement
set
link
in
in
in
the
slide,
and
it
will
give
you
exact
details
on
on
where
this
is
available,
but
for
folks
that
are
excited
to
use
this,
let's
go
ahead
and
talk
about
each
of
these
and
how
they
can
help.
You
manage
the
set
of
shortcuts
that
you
may
have
for
your
for
your
add-in
all
right.
Oh
I
went
backwards
here
we
go.
A
A
A
Now
you
can
use
office.actions.replay
shortcuts
and
all
you
do
is
feed
it,
that
action
id
and
any
new
shortcut
combination
that
you
would
like
to
replace
whatever
you
have
had
in
the
extended
manifest
file.
The
small
caveat
here
is
that
you
can't
create
new
shortcuts
on
the
go
right,
so
you
can
only
customize
the
shortcuts
that
you
have
already
previously
defined
in
your
manifest
and
the
value
that
that
you
put
into
this
api.
A
It
has
to
be
a
string
that
defines
that
custom
shortcut
combination,
so
you
can
see
an
example
here
we
are
changing
the
combinations
for
the
show,
tasking
and
high
task
pane
actions
to
control
shift,
1
and
control
shift
2.,
and
it's
a
very
simple,
very
simple
api
call
and
you
can
send
in
a
whole
list
of
shortcut
customizations
at
once.
One
thing
I
do
want
to
call
out
is:
this:
is
going
to
be
saved
per
user
per
platform.
A
So
if
you
are
calling
this
operation
for
a
certain
user
that
is
already
logged
into
office,
we're
going
to
be
saving
it
in
that
user's
roaming
settings.
So
if
they
go
from
one
windows
machine
to
another
windows
machine,
they
will
have
these
customizations
there
for
them,
but
they
are
saved
per
platform.
So
that
means,
if
they're
switching
from
windows
to
web.
You
will
need
to
call
this
customization
api
again
to
to
make
sure
that
you're
synced
across
the
different
platforms
and
then
the
main
reason
for
that
is.
A
There
are
some
small
areas
where
web
has
different
different
shortcuts
than
than
windows.
So
we
make
sure
that
flexibility
is
still
there
for
you
to
account
for
that,
and
then
the
last
thing
is
the
value
that
you
send
in
the
actual
shortcut
combination.
It
can
also
be
no,
and
what
that
does
is
just
remove
any
previous
customizations
that
you
may
have
set
for
that
shortcut
action.
So
this
is
probably
the
api
that
you'll
be
using
the
most
replace
shortcuts.
A
If
you
have
any
questions,
do
let
us
know
in
the
chat
the
second
api
that
that
we
are
introducing
is
get
shortcuts
right.
So
you
can
imagine
that
as
you're
making
these
customizations
for
your
user,
you
want
to
know
exactly
what
customizations
this
user
has
made
in
the
past
and
then
be
able
to
actually
show
that
to
the
user
at
least
use
that
for
your
own
information.
A
So
what
to
get
shortcuts
is
going
to
do
is
going
to
essentially
just
return
to
you
every
single
shortcut
that
the
current
user
can
currently
use
right.
So
this
can
change
over
the
course
of
the
lifetime
that
the
user
is
using
your
add-in.
Of
course
things
can
happen.
So,
for
example,
if
a
shortcut
conflicts
with
other
add-ins
and
they
see
that
small
conflict
dialogue
pop
up
and
they
choose
to
disable
the
shortcut
for
your
add-in,
the
value
that's
returned
with
that
action
is
going
to
be
no
because
right
now,
there's
no
shortcut
combination.
A
A
This
get
shortcuts
api
is
going
to
return
any
new
customized
shortcuts
for
this
user
and
then,
of
course,
the
third
option
is:
if
there
has
been
no
conflicts
and
there
has
been
no
customizations,
it
will
essentially
just
return
back
to
you,
whatever
you
have
defined
in
that
extended
manifest
json
file.
But
the
main
goal
here
is
to
make
it
easy
for
you
to
create
some
kind
of
ui
to
tell
the
user
hey.
These
are
the
shortcuts
that
you
have
available
right
now.
A
This
is
what
you
can
use
to
invoke
the
actions
in
the
add-in,
and
so
you
can
use
this
get
shortcuts
method
for
every
user
to
to
create
that
that
ui,
that
you
have
and
then
the
third,
the
third
new
api
that
we're
introducing
is
our
shortcuts
in
use.
So
this
is
this
is
going
to
be
very
helpful
for
for
most
of
you
that
that
are
trying
to
avoid
any
shortcuts
that
either
excel
is
already
using
in
terms
of
native
shortcuts,
or
there
may
be
other
add-ins
that
your
users
have.
A
A
Hey
is
this
shortcut
already
in
use
by
this
user
and
if
so,
then
you
can
avoid
using
that
shortcuts
as
part
of
your
replay
shortcuts
method-
and
you
can
incorporate
this
into
your
ui
as
well-
if,
if
you
have
some
kind
of
customization
ui,
where
you
want
to
ask
the
user
for
a
shorter
combination
that
they
want
to
customize,
you
can
go
ahead
and
first
check
using
this
this
api
to
see
hey.
Is
there
a
conflict
with
the
shortcut
and
if
so,
then
let
your
users
know
like
hey.
A
Can
you
please
pick
a
different
shortcut,
because
this
one
is
already
in
use-
and
this
is
just
this
is
just
meant
to
be
a
quick
check
that
can
help
you
avoid
those
conflicts
in
the
future,
all
right.
So
those
are
the
the
three
main
apis
that
we
are
introducing
as
part
of
the
the
keyboard
shortcuts
1.1
requirement
set.
B
B
So
here
I've
opened
a
sample
data
set
and
I
will
go
ahead
and,
for
example,
we
can
select
the
state
and
we
can
press
the
shortcut
here.
We
can
set
the
date
format
by
pressing
ctrl
shift
d
and
that
will
change
the
date
format
or
we
can
try
a
different
shortcut
such
as
set
color
by
pressing
ctrl
shift
o
and
it
will
change
the
color
of
the
selected
grid.
Let's
say
we
can
also
select
some
text
over
here
and
do
underline
by
doing
ctrl
shift.
B
U,
however,
there
will
be
a
conflict,
so
we
can
go
ahead
and
press
on
get
shortcuts
in
use,
which
will
tell
us
that
currently
control,
2,
3
4
6
7
are
not
in
use,
so
we
can
go
ahead
and
replace
those
shortcuts
by
pressing
the
replay
shortcuts
button
and
now
set
isaiah
like
would
become
ctrl
shift.
5
sorry
set
underline
will
be
ctrl
shift
6,
so
we
can
go
ahead
and
do
ctrl
6
and
then
underline
the
text,
and
I
also
want
to
show
that
that
this
setting
will
persist
over
in
the
new
workbook.
B
And
wait
a
little
for
the
sample
to
insert
and
then
we
can
press
ctrl
7,
which
is
to
open
up
the
task
pane.
If
we
do
get
shortcuts.
You
can
see
that
the
old
settings
from
the
customization
from
the
previous
workbook
will
persist
over
here
and
if
we
want
to
revert
back
to
the
old
setting,
we
can
simply
press
reset
shortcut.
This
operation
takes
a
little
while
so
we're
gonna
give
it
a
few
seconds
and
we
can
do
get
shortcuts
again.
B
Sorry,
still
in
the
middle
there
we
go
and
then
you
can
see
that
all
the
settings
have
revert
back
to
before
and
we
press
ctrl
shift
down.
It
will
also
again
show
you
the
conflict
and
then
we
can
hide
the
dialog
and
then
it
will
go
away,
and
so
that
would
be
the
demo
of
the
sample
item
with
the
customization
api
and
if
we
look
at
the
code
behind
it,
so
for
I'd
like
to
point
out
the
replace
shortcut,
the
reset
shortcut
and
the
print
shortcut
in
use.
B
So
over
here
we
have
for
replace
shortcut.
We
simply
set
in
a
function
with
a
loop
over
here,
assigning
control
with
a
number
into
it,
and
the
replace
shortcut
takes
a
array
of
shortcut
key
and
we'll
assign
it
to
the
shortcut
to
replace
it
and
as
for
reset
shortcut,
as
mentioned
in
the
slides
as
well,
we
simply
need
to
set
the
shortcut
to
be
null
and
it
will
revert
back
to
the
original
change
as
well
as
shortcut
and
use.
B
A
Awesome
so
just
to
end
off
here.
So,
as
I
mentioned,
this
kibo
shortcuts
1.1
is
currently
in
preview.
So
that
means
this
is
the
time
for
everyone
else
to
please
try
it
out
play
around
with
it.
Let
us
know
what
you
like
what
you
don't
like.
If
there's
any
issues
it
gives
us
the
chance
to
fix
it
so
for
ga,
we
we
expect
to
include
any
of
the
bug
fixes
that
we
find,
but
you
can
expect
there
to
not
be
any
major
design
changes
here.
I
think
we
are.
A
We
are
well
aligned
on
the
the
three
different
apis
that
we
have.
So
if
you
have
any
feedback,
let
us
know
if
you
have
any
bugs,
please
let
us
know
and
feel
free
to
post
them
in
that
github
repo
that
I
have
linked
on
this
slide.
So
thank
you,
everyone
that
that
was
that
was
it
for
keyboard
shortcut
customization
here.
A
Yes,
that's
correct
alex,
so
I
believe
hj
had
an
answer
there.
We
don't
have
a
plan
to
extend
this
for
word
or
powerpoint
at
the
moment,
but
if
that
is
something
you
want,
let
us
know,
of
course,
the
whole
reason
we
started
this
for
excel
was
we
had
such
a
such
a
high
demand
from
from
everyone
in
the
developer
community?
So
if
you
want
to
see
this
go
on
to
word
and
powerpoint,
please
let
us
know
through
the
chat
and
through
through
other
means
of
communication
here.
Thank
you.